XML Root element. A description of what software provider and organization are sending this XML information. Many sources can be grouped together into one XML file.
<xs:element name="Sources" type="hmis:sources"><xs:annotation><xs:documentation xml:lang="en">XML Root element. A description of what software provider and organization are sending this XML information. Many sources can be grouped together into one XML file.</xs:documentation></xs:annotation></xs:element>
if (hmis:SourceType/text()!='1') then boolean(hmis:SourceName) else true()
if (hmis:SourceType/text()='1') then boolean(hmis:SourceID) else true()
Source
<xs:element name="Source" type="hmis:source" minOccurs="1" maxOccurs="unbounded"><xs:annotation><xs:documentation xml:lang="en">A description of what software provider and organization are sending this XML information. Many sources can be grouped together into one XML file.</xs:documentation></xs:annotation></xs:element>
Reference to the Source's unique ID. If SourceType = 1, this field may not be null and must identify the HUD CoC Code of the HMIS implementation from which data are being exported in the format of two letters, a dash, and 3 numbers. ^[a-zA-Z]{2}-[0-9]{3}$ . If SourceType !=1, this field may be null or used to specify other characteristics, as agreed upon by sender and receiver.
<xs:element name="SourceID" type="hmis:string32" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Reference to the Source's unique ID. If SourceType = 1, this field may not be null and must identify the HUD CoC Code of the HMIS implementation from which data are being exported in the format of two letters, a dash, and 3 numbers. ^[a-zA-Z]{2}-[0-9]{3}$ . If SourceType !=1, this field may be null or used to specify other characteristics, as agreed upon by sender and receiver.</xs:documentation></xs:annotation></xs:element>
Identifies whether the source database is a continuum-operated HMIS (1), an agency-specific database (2), a data warehouse (3), or other (4). An HMIS implementation operated jointly by more than one continuum should be identified as a data warehouse.
<xs:element name="SourceType" type="hmis:sourceType"><xs:annotation><xs:documentation xml:lang="en">Identifies whether the source database is a continuum-operated HMIS (1), an agency-specific database (2), a data warehouse (3), or other (4). An HMIS implementation operated jointly by more than one continuum should be identified as a data warehouse.</xs:documentation></xs:annotation></xs:element>
If the source database is not an HMIS implementation (if SourceType != 1), this field may not be null and must identify the organization responsible for the database.
<xs:element name="SourceName" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">If the source database is not an HMIS implementation (if SourceType != 1), this field may not be null and must identify the organization responsible for the database.</xs:documentation></xs:annotation></xs:element>
<xs:element name="SoftwareName" type="hmis:string50"><xs:annotation><xs:documentation xml:lang="en">The name of the software provider generating this XML.</xs:documentation></xs:annotation></xs:element>
Version number of the software being used by the software provider.
Diagram
Type
xs:string
Properties
content
simple
Source
<xs:element name="SoftwareVersion" type="xs:string"><xs:annotation><xs:documentation xml:lang="en">Version number of the software being used by the software provider.</xs:documentation></xs:annotation></xs:element>
<xs:element name="SourceContactEmail" type="hmis:email" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Email address of the person to contact about this XML data.</xs:documentation></xs:annotation></xs:element>
<xs:element name="SourceContactExtension" type="hmis:extension" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Used with SourceContactPhone to contact the person who can answer questions about this XML.</xs:documentation></xs:annotation></xs:element>
<xs:element name="SourceContactFirst" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">First name of the person to contact about this XML data.</xs:documentation></xs:annotation></xs:element>
<xs:element name="SourceContactLast" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Last name of the person to contact about this XML data.</xs:documentation></xs:annotation></xs:element>
<xs:element name="SourceContactPhone" type="hmis:phoneNumber" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Phone number of the person to contact about this XML data; used with SourceContactExtension.</xs:documentation></xs:annotation></xs:element>
An export is a set of data being transmitted for a specific purpose (see ExportType). A single XML file can have many different Exports of different types and date ranges.
<xs:element name="ExportID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Export's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ExportDate" type="xs:dateTime"><xs:annotation><xs:documentation xml:lang="en">Time the export was performed.</xs:documentation></xs:annotation></xs:element>
<xs:element name="ExportPeriod" type="hmis:dateRangeCapped"><xs:annotation><xs:documentation xml:lang="en">The date range bounding the data set being transmitted. Used with ExportPeriodType to clarify what the date range represents.</xs:documentation></xs:annotation></xs:element>
Exported data sets with an ExportPeriodType of ‘updated’ will include all records with a dateCreated, dateUpdated, or a dateDeleted that falls between the Export.StartDate and the Export.EndDate.
enumeration
effective
Exported data sets with an ExportPeriod type of ‘effective’ will include all enrollment data, along with associated client and project descriptor data, where the informationDate (or other effective date such as Project.EntryDate, Project.ExitDate, ContactDate, etc.) falls between the Export.StartDate and the Export.EndDate.
enumeration
reportingPeriod
‘reportingPeriod’ exports include all records needed for reporting on clients and enrollments active in the export period. This will include all records in Enrollments (regardless of informationDate, dateCreated, dateUpdated, etc.), client files, and project descriptor files associated with a ProjectEntryID where: ProjectEntryDate is on or before the Export.EndDate; Project.ExitDate is null OR Project.ExitDate is on or after the Export.StartDate; ProjectID is associated with a project selected by a user for export OR the user did not choose to filter the export by Project; A CoCCode associated with the ProjectEntryID matches a CoCCode selected by a user for export OR the user did not choose to filter the export by CoCCode.
enumeration
other
The ‘other’ type of ExportPeriodType is used to identify exports in which records were selected based upon parameters mutually agreed upon by the sender and recipient of the XML data."
Source
<xs:element name="ExportPeriodType" type="hmis:exportPeriodType"><xs:annotation><xs:documentation xml:lang="en">Pick one of the types to specify the definition of export period being used in ExportPeriod.</xs:documentation></xs:annotation></xs:element>
The data contained in this file is meant to be synchronized with an existing data set.
enumeration
fullRefresh
The data contained in this file is meant to replace an existing data set for the export period.
enumeration
other
The data contained in this file were selected based upon parameters mutually agreed upon by the sender and recipient of the XML data.
Source
<xs:element name="ExportDirective" type="hmis:exportDirective"><xs:annotation><xs:documentation xml:lang="en">Select one of the ExportDirective choices to instruct the target as to how the data being transmitted should be handled.</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="AffiliationID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Affiliation's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to a Project element</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
Hash Status 1 = Unhashed 2 = SHA-1 RHY3 = Hashed - other
Source
<xs:element name="SSN" type="hmis:ssnHashingOption" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.2.1.</xs:documentation><xs:documentation xml:lang="en">Unknown SSN digits should be indicated with a lower case "x".</xs:documentation></xs:annotation><xs:alternative test="@hmis:hashStatus='1'" type="hmis:ssnHashingOptionPlain"/><xs:alternative test="@hmis:hashStatus='2'" type="hmis:ssnHashingOptionSHA1RHY"/><xs:alternative test="@hmis:hashStatus='3'" type="hmis:ssnHashingOption"/><xs:alternative test="@hmis:hashStatus" type="hmis:ssnHashingOptionPlain"/></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="ConnectionWithSOARID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the connectionWithSOAR's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="DateOfEngagementID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the DateOfEngagement's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:TCellCountAvailable) then boolean(hmis:DisabilityType/text()='8') else true()
if (hmis:TCellCountAvailable/text()='1') then boolean(hmis:TCellCount) else (if (not(hmis:TCellCountAvailable/text()='1'))
then (not(boolean(hmis:TCellCount))) else false())
if (hmis:TCellCount) then boolean(hmis:TCellSource) else (if (not(hmis:TCellCount))
then (not(boolean(hmis:TCellSource))) else false())
if (hmis:ViralLoadAvailable) then boolean(hmis:DisabilityType/text()='8') else true()
if (hmis:ViralLoadAvailable/text()='1') then boolean(hmis:ViralLoad) else (if (not(hmis:ViralLoadAvailable/text()='1'))
then (not(boolean(hmis:ViralLoad))) else false())
if (hmis:ViralLoad) then boolean(hmis:ViralLoadSource) else (if (not(hmis:ViralLoad))
then (not(boolean(hmis:ViralLoadSource))) else false())
<xs:element name="DisabilitiesID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Exit's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
The permissible values correspond to the decimal values of the corresponding disability types. 4.5 Physical Disability is "5" and 4.10 Substance Abuse is "10".
<xs:element name="DisabilityType" type="hmis:disabilityType"><xs:annotation><xs:documentation xml:lang="en">The permissible values correspond to the decimal values of the corresponding disability types. 4.5 Physical Disability is "5" and 4.10 Substance Abuse is "10".</xs:documentation></xs:annotation></xs:element>
See August 2016 HMIS Data Dictionary, Section 4.5-4.10, Response #2. Permissable values vary depending on which disability type is declared. The values are contined with "Field and Response(s) 2" within 4.5 through 4.10.
Diagram
Type
xs:nonNegativeInteger
Properties
content
simple
Source
<xs:element name="DisabilityResponse" type="xs:nonNegativeInteger"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.5-4.10, Response #2. Permissable values vary depending on which disability type is declared. The values are contined with "Field and Response(s) 2" within 4.5 through 4.10.</xs:documentation></xs:annotation></xs:element>
Schema location
file:/home/eric/git/hmis-xml/src/HUD_HMIS.xsd
Element disabilities / IndefiniteAndImpairsIndependence
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:DomesticViolenceVictim/text()='1') then boolean(hmis:CurrentlyFleeing) else
(if (not(hmis:DomesticViolenceVictim/text()='1')) then (not(boolean(hmis:CurrentlyFleeing)))
else false())
<xs:element name="DomesticViolenceID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the DomesticViolence's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="EducationID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the LastGradeCompleted's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="EmploymentID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Employment's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:TimesHomelessPastThreeYears/text()='1' or hmis:TimesHomelessPastThreeYears/text()='2'
or hmis:TimesHomelessPastThreeYears/text()='3' or hmis:TimesHomelessPastThreeYears/text()='4')
then boolean(hmis:MonthsHomelessPastThreeYears) else (if (not(hmis:TimesHomelessPastThreeYears/text()='1'
or hmis:TimesHomelessPastThreeYears/text()='2' or hmis:TimesHomelessPastThreeYears/text()='3'
or hmis:TimesHomelessPastThreeYears/text()='4')) then (not(boolean(hmis:MonthsHomelessPastThreeYears)))
else false())
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Enrollment's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="PersonalID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Client's ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the associated Project's ID</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="EnrollmentCoCID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the EnrollmentCoC's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment's ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="HouseholdID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Household ID, as a convenience</xs:documentation></xs:annotation></xs:element>
<xs:element name="CoCCode" type="hmis:cocCode"><xs:annotation><xs:documentation xml:lang="en">Key reference to the CoC's ID</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:Destination/text()='17') then boolean(hmis:OtherDestination) else (if (not(hmis:Destination/text()='17'))
then (not(boolean(hmis:OtherDestination))) else false())
<xs:element name="ExitID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Exit's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="ExitHousingAssessmentID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the ExitHousingAssessment's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ExitID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="ExitRHYID" type="hmis:string32" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Reference to the ExitRHY' unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ExitID" type="hmis:string32" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
See August 2016 HMIS Data Dictionary, Section 4.37.1. In communities exporting HUDVASH VA Repository, may also contain data for HUD-VASH Exit Information (not defined in the HMIS Data Standards) using list 4.51.1
Youth was expelled or otherwise involuntarily discharged from project
enumeration
99
Data not collected
Source
<xs:element name="ProjectCompletionStatus" type="hmis:projectCompletionStatusSimple" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.37.1. In communities exporting HUDVASH VA Repository, may also contain data for HUD-VASH Exit Information (not defined in the HMIS Data Standards) using list 4.51.1</xs:documentation></xs:annotation></xs:element>
Left for other opportunities – Independent living *OR* Criminal activity/destruction of property/violence
enumeration
2
Left for other opportunities - Education *OR* Non-compliance with project rules
enumeration
3
Left for other opportunities - Military *OR* Non-payment of rent/occupancy charge
enumeration
4
Left for other opportunities - Other *OR* Reached maximum time allowed by project
enumeration
5
Needs could not be met by project *OR* Project terminated
enumeration
6
Unknown/disappeared
enumeration
99
Data not collected
Source
<xs:element name="EarlyExitReason" type="hmis:earlyExitReason" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.37, 1A or 1B, depending on whether 2 (use 1A) or 3 (use 1B) is the response to 4.37.</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="FunderID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Funder's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to a Project element</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:IndianHealthServices/text()='0') then boolean(hmis:NoIndianHealthServicesReason)
else (if (not(hmis:IndianHealthServices/text()='0')) then (not(boolean(hmis:NoIndianHealthServicesReason)))
else false())
if (hmis:OtherInsurance/text()='1') then boolean(hmis:OtherInsuranceIdentify) else
(if (not(hmis:OtherInsurance/text()='1')) then (not(boolean(hmis:OtherInsuranceIdentify)))
else false())
if (hmis:Medicaid/text()='0') then boolean(hmis:NoMedicaidReason) else (if (not(hmis:Medicaid/text()='0'))
then (not(boolean(hmis:NoMedicaidReason))) else false())
if (hmis:Medicare/text()='0') then boolean(hmis:NoMedicareReason) else (if (not(hmis:Medicare/text()='0'))
then (not(boolean(hmis:NoMedicareReason))) else false())
if (hmis:SCHIP/text()='0') then boolean(hmis:NoSCHIPReason) else (if (not(hmis:SCHIP/text()='0'))
then (not(boolean(hmis:NoSCHIPReason))) else false())
if (hmis:VAMedicalServices/text()='0') then boolean(hmis:NoVAMedReason) else (if (not(hmis:VAMedicalServices/text()='0'))
then (not(boolean(hmis:NoVAMedReason))) else false())
if (hmis:EmployerProvided/text()='0') then boolean(hmis:NoEmployerProvidedReason)
else (if (not(hmis:EmployerProvided/text()='0')) then (not(boolean(hmis:NoEmployerProvidedReason)))
else false())
if (hmis:COBRA/text()='0') then boolean(hmis:NoCOBRAReason) else (if (not(hmis:COBRA/text()='0'))
then (not(boolean(hmis:NoCOBRAReason))) else false())
if (hmis:PrivatePay/text()='0') then boolean(hmis:NoPrivatePayReason) else (if (not(hmis:PrivatePay/text()='0'))
then (not(boolean(hmis:NoPrivatePayReason))) else false())
if (hmis:StateHealthIns/text()='0') then boolean(hmis:NoStateHealthInsReason) else
(if (not(hmis:StateHealthIns/text()='0')) then (not(boolean(hmis:NoStateHealthInsReason)))
else false())
Source
<xs:element name="HealthInsurance" type="hmis:healthInsurance"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4</xs:documentation></xs:annotation></xs:element>
<xs:element name="HealthInsuranceID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the HealthInsurance's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="HealthStatusID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the HealthStatus' unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
The permissible values correspond to the decimal values of the corresponding health category. 4.27 General Health Status is "27" and 4.29 Mental Health Status is "29" and 4.30 Pregnancy Status is "30".
<xs:element name="HealthCategory" type="hmis:healthCategory"><xs:annotation><xs:documentation xml:lang="en">The permissible values correspond to the decimal values of the corresponding health category. 4.27 General Health Status is "27" and 4.29 Mental Health Status is "29" and 4.30 Pregnancy Status is "30".</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="HousingAssessmentDispositionID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the HousingAssessmentDisposition's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ExitID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the ExitID</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:Earned/text()='1') then boolean(hmis:EarnedAmount) else (if (not(Earned/text()='1'))
then (not(boolean(hmis:EarnedAmount))) else false())
if (hmis:Unemployment/text()='1') then boolean(hmis:UnemploymentAmount) else (if (not(Unemployment/text()='1'))
then (not(boolean(hmis:UnemploymentAmount))) else false())
if (hmis:SSI/text()='1') then boolean(hmis:SSIAmount) else (if (not(SSI/text()='1'))
then (not(boolean(hmis:SSIAmount))) else false())
if (hmis:SSDI/text()='1') then boolean(hmis:SSDIAmount) else (if (not(SSDI/text()='1'))
then (not(boolean(hmis:SSDIAmount))) else false())
if (hmis:VADisabilityService/text()='1') then boolean(hmis:VADisabilityServiceAmount)
else (if (not(VADisabilityService/text()='1')) then (not(boolean(hmis:VADisabilityServiceAmount)))
else false())
if (hmis:PrivateDisability/text()='1') then boolean(hmis:PrivateDisabilityAmount)
else (if (not(PrivateDisability/text()='1')) then (not(boolean(hmis:PrivateDisabilityAmount)))
else false())
if (hmis:WorkersComp/text()='1') then boolean(hmis:WorkersCompAmount) else (if (not(WorkersComp/text()='1'))
then (not(boolean(hmis:WorkersCompAmount))) else false())
if (hmis:TANF/text()='1') then boolean(hmis:TANFAmount) else (if (not(TANF/text()='1'))
then (not(boolean(hmis:TANFAmount))) else false())
if (hmis:GA/text()='1') then boolean(hmis:GAAmount) else (if (not(GA/text()='1'))
then (not(boolean(hmis:GAAmount))) else false())
if (hmis:SocSecRetirement/text()='1') then boolean(hmis:SocSecRetirementAmount) else
(if (not(SocSecRetirement/text()='1')) then (not(boolean(hmis:SocSecRetirementAmount)))
else false())
if (hmis:Pension/text()='1') then boolean(hmis:PensionAmount) else (if (not(Pension/text()='1'))
then (not(boolean(hmis:PensionAmount))) else false())
if (hmis:ChildSupport/text()='1') then boolean(hmis:ChildSupportAmount) else (if (not(ChildSupport/text()='1'))
then (not(boolean(hmis:ChildSupportAmount))) else false())
if (hmis:Alimony/text()='1') then boolean(hmis:AlimonyAmount) else (if (not(Alimony/text()='1'))
then (not(boolean(hmis:AlimonyAmount))) else false())
if (hmis:OtherSource/text()='1') then boolean(hmis:OtherSourceAmount) else (if (not(OtherSource/text()='1'))
then (not(boolean(hmis:OtherSourceAmount))) else false())
if (hmis:OtherSource/text()='1') then boolean(hmis:OtherSourceIdentify) else (if (not(OtherSource/text()='1'))
then (not(boolean(hmis:OtherSourceIdentify))) else false())
Source
<xs:element name="IncomeAndSources" type="hmis:incomeAndSources"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2</xs:documentation></xs:annotation></xs:element>
<xs:element name="IncomeAndSourcesID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the IncomeAndSources' unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="InventoryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Inventory's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Project</xs:documentation></xs:annotation></xs:element>
<xs:element name="CoCCode" type="hmis:cocCode"><xs:annotation><xs:documentation xml:lang="en">Key reference to the CoC</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:HIVAIDSAssistance/text()='0') then boolean(hmis:NoHIVAIDSAssistanceReason)
else (if (not(hmis:HIVAIDSAssistance/text()='0')) then (not(boolean(hmis:NoHIVAIDSAssistanceReason)))
else false())
Source
<xs:element name="MedicalAssistance" type="hmis:medicalAssistance"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.39</xs:documentation></xs:annotation></xs:element>
<xs:element name="MedicalAssistanceID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the MedicalAssistance's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="NonCashBenefitsID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the NonCashBenefits's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="OrganizationCommonName" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Referenced but not defined in the HMIS Data Dictionary.</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:ClientEnrolledInPATH/text()='0') then boolean(hmis:ReasonNotEnrolled) else
(if (not(hmis:ClientEnrolledInPATH/text()='0')) then (not(boolean(hmis:ReasonNotEnrolled)))
else false())
Source
<xs:element name="PATHStatus" type="hmis:pathStatus"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.20</xs:documentation></xs:annotation></xs:element>
<xs:element name="PathStatusID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the PathStatus' unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="EntrySSVFID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the EntrySSVFID's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="OrganizationID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Organization</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectCommonName" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">A local or commonly used name for a project. This is not referenced in the August 2016 HMIS Data Dictionary, and is optional.</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="CoCCode" type="hmis:cocCode"><xs:annotation><xs:documentation xml:lang="en">Key reference to the CoCCode ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Project ID</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="ResidentialMoveInDateID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the ResidentialMoveInDate's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:FYSBYouth/text()='0') then boolean(hmis:ReasonNoServices) else (if (not(hmis:FYSBYouth/text()='0'))
then (not(boolean(hmis:ReasonNoServices))) else false())
Source
<xs:element name="RHYBCPStatus" type="hmis:rhyBCPStatus"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.22</xs:documentation></xs:annotation></xs:element>
<xs:element name="RHYBCPStatusID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the RHYBCPStatus' unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (not (hmis:RecordType/text() ='144' and hmis:TypeProvided/text() ='6')) then not
(boolean(hmis:OtherTypeProvided)) else boolean(hmis:OtherTypeProvided)
if (not (hmis:RecordType/text() ='144' and (hmis:TypeProvided/text() ='3' or hmis:TypeProvided/text()
='4' or hmis:TypeProvided/text() ='5'))) then not (boolean(hmis:SubTypeProvided))
else boolean(hmis:TypeProvided)
if (not (hmis:RecordType/text() ='151') and not (hmis:RecordType/text() ='152')) then
(not (boolean(hmis:FAAmount))) else boolean(hmis:FAAmount)
Source
<xs:element name="ServiceFAReferral" type="hmis:serviceFAReferral"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.14-4.16</xs:documentation></xs:annotation></xs:element>
<xs:element name="ServiceFAReferralID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Services' unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
See August 2016 HMIS Data Dictionary, Section 4.12 and 4.14-4.16.1.
Diagram
Type
xs:date
Properties
content
simple
Source
<xs:element name="DateProvided" type="xs:date"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.12 and 4.14-4.16.1.</xs:documentation></xs:annotation></xs:element>
The permissible values correspond to the decimal values of the corresponding Service FA Referral and Contact types. 4.12 Contact is "12", 4.14 Services Provided is "14X", 4.15 Financial Assistance is "15X", 4.16 Referrals Provided is "16X", Bed Night is "200", and is HUD-VASH OTH voucher tracking "210".
<xs:element name="RecordType" type="hmis:recordType"><xs:annotation><xs:documentation xml:lang="en">The permissible values correspond to the decimal values of the corresponding Service FA Referral and Contact types. 4.12 Contact is "12", 4.14 Services Provided is "14X", 4.15 Financial Assistance is "15X", 4.16 Referrals Provided is "16X", Bed Night is "200", and is HUD-VASH OTH voucher tracking "210".</xs:documentation></xs:annotation></xs:element>
See August 2016 HMIS Data Dictionary, Section 4.12 and 4.14-4.16.2 (picklist values vary by service category and funder).
In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 12 (Contact Location 4.12.2): 1 = Place not meant for habitation 2 = Service setting, non-residential 3 = Service setting, residential In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 141 (PATH Services 4.14.A): PATH Services 1 = Re-engagement 2 = Screening 3 = Habilitation/rehabilitation 4 = Community mental health 5 = Substance use treatment 6 = Case management 7 = Residential supportive services 8 = Housing minor renovation 9 = Housing moving assistance 10 = Housing eligibility determination 11 = Security deposits 12 = One-time rent for eviction prevention 14 = Clinical assessment In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 142 (RHY Services 4.14.B): 1 = Basic support services 2 = Community service/service learning (CSL) 3 = Counseling/therapy 4 = Dental care 5 = Education 6 = Employment and training services 7 = Criminal justice /legal services 8 = Life skills training 9 = Parenting education for parent of youth 10 = Parenting education for youth with children 11 = Peer (youth) counseling 12 = Post-natal care 13 = Pre-natal care 14 = Health/medical care 15 = Psychological or psychiatric care 16 = Recreational activities 17 = Substance abuse assessment and/or treatment 18 = Substance abuse prevention 19 = Support group 20 = Preventative – overnight interim, respite 21 = Preventative – formal placement in an alternative setting outside of BCP 22 = Preventative – entry into BCP after preventative services 23 = Street outreach – health and hygiene products distributed 24 = Street outreach – food and drink items 25 = Street outreach – services information/brochures In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 143 (HOPWA Services 4.14.C): 1 Adult day care and personal assistance 2 Case management 3 Child care 4 Criminal justice/legal services 5 Education 6 Employment and training services 7 Food/meals/nutritional services 8 Health/medical care 9 Life skills training 10 Mental health care/counseling 11 Outreach and/or engagement 12 Substance abuse services/treatment 13 Transportation 14 Other HOPWA funded service In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 144 (SSVF Services 4.14.D): 1 Outreach services 2 Case management services 3 Assistance obtaining VA benefits 4 Assistance obtaining/coordinating other public benefits 5 Direct provision of other public benefits 6 Other (non-TFA) supportive service approved by VA In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 151 (Financial Assistance - HOPWA Services 4.15.A): 1 Rental assistance [collect for PHP and STRMU] 2 Security deposits [collect for PHP] 3 Utility deposits [collect for PHP] 4 Utility payments [collect for PHP and STRMU] 7 Mortgage assistance [collect for STRMU] In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 152 (Financial Assistance – SSVF 4.15.B): 1 Rental assistance 4 Utility fee payment assistance 2 Security deposit 3 Utility deposit 5 Moving costs 8 Transportation services: tokens/vouchers 9 Transportation services: vehicle repair/maintenance 10 Child Care 11 General housing stability assistance - emergency supplies 12 General housing stability assistance - other 14 Emergency housing assistance In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 161 (Referrals Provided – PATH 4.16.A): 1 Community Mental Health 2 Substance Use Treatment 3 Primary Health/ Dental Care 4 Job Training 5 Educational Services 6 Housing Services 11 Temporary Housing 7 Permanent Housing 8 Income Assistance 9 Employment Assistance 10 Medical Insurance In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 162 (Referrals Provided - RHY 4.16.B): 1 Child Care Non-TANF 2 Supplemental Nutritional Assistance Program (Food Stamps) 3 Education – McKinney/Vento Liaison Assistance to Remain in School 4 HUD Section 8 or Other Permanent Housing Assistance 5 Individual Development Account 6 Medicaid 7 Mentoring Program Other than RHY Agency 8 National Service (Americorp, VISTA, Learn and Serve) 9 Non-Residential Substance Abuse or Mental Health Program 10 Other Public – Federal, State, or Local Program 11 Private Non-profit Charity or Foundation Support 12 SCHIP 13 SSI, SSDI, or other Disability Insurance 14 TANF or other Welfare/Non-Disability Income Maintenance (all TANF Services) 15 Unemployment Insurance 16 WIC 17 Workforce Development (WIA) In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 200 (Services Provided - Bed-night Date 4.14E): 200 BedNight In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 210 (Services Provided - HUD-VASH OTH voucher tracking 4.50.1): 4.50.1 VoucherTracking Value Text 1 Referral package forwarded to PHA 2 Voucher denied by PHA 3 Voucher issued by PHA 4 Voucher revoked or expired 5 Voucher in use – veteran moved into housing 6 Voucher was ported locally 7 Voucher was administratively absorbed by new PHA 8 Voucher was converted to Housing Choice Voucher 9 Veteran exited – voucher was returned 10 Veteran exited – family maintained the voucher 11 Veteran exited – prior to ever receiving a voucher 12 Other
Diagram
Type
restriction of xs:integer
Properties
content
simple
Facets
pattern
([\-+]?[0-9]+) & ([0-9]{1,3})
Source
<xs:element name="TypeProvided"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.12 and 4.14-4.16.2 (picklist values vary by service category and funder).</xs:documentation><xs:documentation xml:lang="en">In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 12 (Contact Location 4.12.2): 1 = Place not meant for habitation 2 = Service setting, non-residential 3 = Service setting, residential In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 141 (PATH Services 4.14.A): PATH Services 1 = Re-engagement 2 = Screening 3 = Habilitation/rehabilitation 4 = Community mental health 5 = Substance use treatment 6 = Case management 7 = Residential supportive services 8 = Housing minor renovation 9 = Housing moving assistance 10 = Housing eligibility determination 11 = Security deposits 12 = One-time rent for eviction prevention 14 = Clinical assessment In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 142 (RHY Services 4.14.B): 1 = Basic support services 2 = Community service/service learning (CSL) 3 = Counseling/therapy 4 = Dental care 5 = Education 6 = Employment and training services 7 = Criminal justice /legal services 8 = Life skills training 9 = Parenting education for parent of youth 10 = Parenting education for youth with children 11 = Peer (youth) counseling 12 = Post-natal care 13 = Pre-natal care 14 = Health/medical care 15 = Psychological or psychiatric care 16 = Recreational activities 17 = Substance abuse assessment and/or treatment 18 = Substance abuse prevention 19 = Support group 20 = Preventative – overnight interim, respite 21 = Preventative – formal placement in an alternative setting outside of BCP 22 = Preventative – entry into BCP after preventative services 23 = Street outreach – health and hygiene products distributed 24 = Street outreach – food and drink items 25 = Street outreach – services information/brochures In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 143 (HOPWA Services 4.14.C): 1 Adult day care and personal assistance 2 Case management 3 Child care 4 Criminal justice/legal services 5 Education 6 Employment and training services 7 Food/meals/nutritional services 8 Health/medical care 9 Life skills training 10 Mental health care/counseling 11 Outreach and/or engagement 12 Substance abuse services/treatment 13 Transportation 14 Other HOPWA funded service In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 144 (SSVF Services 4.14.D): 1 Outreach services 2 Case management services 3 Assistance obtaining VA benefits 4 Assistance obtaining/coordinating other public benefits 5 Direct provision of other public benefits 6 Other (non-TFA) supportive service approved by VA In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 151 (Financial Assistance - HOPWA Services 4.15.A): 1 Rental assistance [collect for PHP and STRMU] 2 Security deposits [collect for PHP] 3 Utility deposits [collect for PHP] 4 Utility payments [collect for PHP and STRMU] 7 Mortgage assistance [collect for STRMU] In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 152 (Financial Assistance – SSVF 4.15.B): 1 Rental assistance 4 Utility fee payment assistance 2 Security deposit 3 Utility deposit 5 Moving costs 8 Transportation services: tokens/vouchers 9 Transportation services: vehicle repair/maintenance 10 Child Care 11 General housing stability assistance - emergency supplies 12 General housing stability assistance - other 14 Emergency housing assistance In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 161 (Referrals Provided – PATH 4.16.A): 1 Community Mental Health 2 Substance Use Treatment 3 Primary Health/ Dental Care 4 Job Training 5 Educational Services 6 Housing Services 11 Temporary Housing 7 Permanent Housing 8 Income Assistance 9 Employment Assistance 10 Medical Insurance In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 162 (Referrals Provided - RHY 4.16.B): 1 Child Care Non-TANF 2 Supplemental Nutritional Assistance Program (Food Stamps) 3 Education – McKinney/Vento Liaison Assistance to Remain in School 4 HUD Section 8 or Other Permanent Housing Assistance 5 Individual Development Account 6 Medicaid 7 Mentoring Program Other than RHY Agency 8 National Service (Americorp, VISTA, Learn and Serve) 9 Non-Residential Substance Abuse or Mental Health Program 10 Other Public – Federal, State, or Local Program 11 Private Non-profit Charity or Foundation Support 12 SCHIP 13 SSI, SSDI, or other Disability Insurance 14 TANF or other Welfare/Non-Disability Income Maintenance (all TANF Services) 15 Unemployment Insurance 16 WIC 17 Workforce Development (WIA) In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 200 (Services Provided - Bed-night Date 4.14E): 200 BedNight In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 210 (Services Provided - HUD-VASH OTH voucher tracking 4.50.1): 4.50.1 VoucherTracking Value Text 1 Referral package forwarded to PHA 2 Voucher denied by PHA 3 Voucher issued by PHA 4 Voucher revoked or expired 5 Voucher in use – veteran moved into housing 6 Voucher was ported locally 7 Voucher was administratively absorbed by new PHA 8 Voucher was converted to Housing Choice Voucher 9 Veteran exited – voucher was returned 10 Veteran exited – family maintained the voucher 11 Veteran exited – prior to ever receiving a voucher 12 Other</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:integer"><xs:pattern value="[0-9]{1,3}"/></xs:restriction></xs:simpleType></xs:element>
<xs:element name="OtherTypeProvided" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.12 and 4.14-4.16.2D (if it exists) .</xs:documentation></xs:annotation></xs:element>
See August 2016 HMIS Data Dictionary, Section 4.12 and 4.14-4.16.3A, 4B, 5C (if it exists).
Diagram
Type
restriction of xs:integer
Properties
content
simple
minOccurs
0
Facets
pattern
([\-+]?[0-9]+) & ([0-9]{1,2})
Source
<xs:element name="SubTypeProvided" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.12 and 4.14-4.16.3A, 4B, 5C (if it exists).</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:integer"><xs:pattern value="[0-9]{1,2}"/></xs:restriction></xs:simpleType></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="SiteID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Site's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="CoCCode" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the CoC</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Project</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="ClientVeteranInfoID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the ClientVeteranInfo's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="PersonalID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Refers to a Client element</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:element name="EntryRHSPID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the EntryRHSP's unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:WorkPlaceViolenceThreats/text()='1' or hmis:WorkplacePromiseDifference/text()='1')
then boolean(hmis:CoercedToContinueWork) else (if (not(hmis:WorkPlaceViolenceThreats/text()='1'
or hmis:WorkplacePromiseDifference/text()='1')) then (not(boolean(hmis:CoercedToContinueWork)))
else false())
if (hmis:WorkPlaceViolenceThreats/text()='1' or hmis:WorkplacePromiseDifference/text()='1')
then boolean(hmis:LaborExploitPastThreeMonths) else (if (not(hmis:WorkPlaceViolenceThreats/text()='1'
or hmis:WorkplacePromiseDifference/text()='1')) then (not(boolean(hmis:LaborExploitPastThreeMonths)))
else false())
if (hmis:ExchangeForSex/text()='1') then boolean(hmis:ExchangeForSexPastThreeMonths)
else (if (not(hmis:ExchangeForSex/text()='1')) then (not(boolean(hmis:ExchangeForSexPastThreeMonths)))
else false())
if (hmis:ExchangeForSex/text()='1') then boolean(hmis:CountOfExchangeForSex) else
(if (not(hmis:ExchangeForSex/text()='1')) then (not(boolean(hmis:CountOfExchangeForSex)))
else false())
if (hmis:ExchangeForSex/text()='1') then boolean(hmis:AskedOrForcedToExchangeForSex)
else (if (not(hmis:ExchangeForSex/text()='1')) then (not(boolean(hmis:AskedOrForcedToExchangeForSex)))
else false())
if (hmis:AskedOrForcedToExchangeForSex/text()='1') then boolean(hmis:AskedOrForcedToExchangeForSexPastThreeMonths)
else (if (not(hmis:AskedOrForcedToExchangeForSex/text()='1')) then (not(boolean(hmis:AskedOrForcedToExchangeForSexPastThreeMonths)))
else false())
Source
<xs:element name="EntryRHY" type="hmis:entryRHY"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.</xs:documentation></xs:annotation></xs:element>
<xs:element name="EntryRHYID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the EntryRHY' unique ID</xs:documentation></xs:annotation></xs:element>
<xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element>
<xs:complexType name="sources"><xs:sequence><xs:element name="Source" type="hmis:source" minOccurs="1" maxOccurs="unbounded"><xs:annotation><xs:documentation xml:lang="en">A description of what software provider and organization are sending this XML information. Many sources can be grouped together into one XML file.</xs:documentation></xs:annotation></xs:element></xs:sequence></xs:complexType>
if (hmis:SourceType/text()!='1') then boolean(hmis:SourceName) else true()
if (hmis:SourceType/text()='1') then boolean(hmis:SourceID) else true()
Source
<xs:complexType name="source"><xs:sequence><xs:element name="SourceID" type="hmis:string32" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Reference to the Source's unique ID. If SourceType = 1, this field may not be null and must identify the HUD CoC Code of the HMIS implementation from which data are being exported in the format of two letters, a dash, and 3 numbers. ^[a-zA-Z]{2}-[0-9]{3}$ . If SourceType !=1, this field may be null or used to specify other characteristics, as agreed upon by sender and receiver.</xs:documentation></xs:annotation></xs:element><xs:element name="SourceType" type="hmis:sourceType"><xs:annotation><xs:documentation xml:lang="en">Identifies whether the source database is a continuum-operated HMIS (1), an agency-specific database (2), a data warehouse (3), or other (4). An HMIS implementation operated jointly by more than one continuum should be identified as a data warehouse.</xs:documentation></xs:annotation></xs:element><xs:element name="SourceName" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">If the source database is not an HMIS implementation (if SourceType != 1), this field may not be null and must identify the organization responsible for the database.</xs:documentation></xs:annotation></xs:element><xs:element name="SoftwareName" type="hmis:string50"><xs:annotation><xs:documentation xml:lang="en">The name of the software provider generating this XML.</xs:documentation></xs:annotation></xs:element><xs:element name="SoftwareVersion" type="xs:string"><xs:annotation><xs:documentation xml:lang="en">Version number of the software being used by the software provider.</xs:documentation></xs:annotation></xs:element><xs:element name="SourceContactEmail" type="hmis:email" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Email address of the person to contact about this XML data.</xs:documentation></xs:annotation></xs:element><xs:element name="SourceContactExtension" type="hmis:extension" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Used with SourceContactPhone to contact the person who can answer questions about this XML.</xs:documentation></xs:annotation></xs:element><xs:element name="SourceContactFirst" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">First name of the person to contact about this XML data.</xs:documentation></xs:annotation></xs:element><xs:element name="SourceContactLast" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Last name of the person to contact about this XML data.</xs:documentation></xs:annotation></xs:element><xs:element name="SourceContactPhone" type="hmis:phoneNumber" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Phone number of the person to contact about this XML data; used with SourceContactExtension.</xs:documentation></xs:annotation></xs:element><xs:element name="Export" type="hmis:export" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation xml:lang="en">An export is a set of data being transmitted for a specific purpose (see ExportType). A single XML file can have many different Exports of different types and date ranges.</xs:documentation></xs:annotation><xs:key name="clientKey"><xs:selector xpath="hmis:Client"/><xs:field xpath="hmis:PersonalID"/></xs:key><xs:key name="cocKey"><xs:selector xpath="hmis:CoC"/><xs:field xpath="hmis:CoCCode"/></xs:key><xs:key name="enrollmentKey"><xs:selector xpath="hmis:Enrollment"/><xs:field xpath="hmis:ProjectEntryID"/></xs:key><xs:key name="exitKey"><xs:selector xpath="hmis:Exit"/><xs:field xpath="hmis:ExitID"/></xs:key><xs:key name="organizationKey"><xs:selector xpath="hmis:Organization"/><xs:field xpath="hmis:OrganizationID"/></xs:key><xs:key name="projectKey"><xs:selector xpath="hmis:Project"/><xs:field xpath="hmis:ProjectID"/></xs:key><xs:keyref name="affiliationProjectKeyRef" refer="projectKey"><xs:selector xpath="hmis:Affiliation"/><xs:field xpath="hmis:ProjectID"/></xs:keyref><xs:keyref name="affiliationResProjectKeyRef" refer="projectKey"><xs:selector xpath="hmis:Affiliation"/><xs:field xpath="hmis:ResProjectID"/></xs:keyref><xs:keyref name="enrollmentClientKeyRef" refer="clientKey"><xs:selector xpath="hmis:Enrollment"/><xs:field xpath="hmis:PersonalID"/></xs:keyref><xs:keyref name="enrollmentCoCCoCKeyRef" refer="cocKey"><xs:selector xpath="hmis:EnrollmentCoC"/><xs:field xpath="hmis:CoCCode"/></xs:keyref><xs:keyref name="enrollmentCoCEnrollmentKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:EnrollmentCoC"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentContactKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:Contact"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentDateOfEngagementKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:DateOfEngagement"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentDisabilitiesKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:Disabilities"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentDomesticViolenceKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:DomesticViolence"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentEducationKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:Education"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentEmploymentKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:Employment"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentEnrollmentCoCKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:EnrollmentCoC"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentExitKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:Exit"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentFormerWardChildWelfareKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:FormerWardChildWelfare"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentFormerWardJuvenileJusticeKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:FormerWardJuvenileJustice"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentHealthInsuranceKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:HealthInsurance"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentHealthStatusKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:HealthStatus"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentIncomeAndSourcesKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:IncomeAndSources"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentMedicalAssistanceKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:MedicalAssistance"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentNonCashBenefitsKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:NonCashBenefits"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentPATHStatusKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:PATHStatus"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentEntrySSVFKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:EntrySSVF"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentReferralSourceKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:ReferralSource"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentResidentialMoveInDateKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:ResidentialMoveInDate"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentRHYBCPStatusKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:NonCashBenefits"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentServiceFAReferralKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:ServiceFAReferral"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentSexualOrientationKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:SexualOrientation"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentEntryRHSPKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:EntryRHSP"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="enrollmentEntryRHYKeyRef" refer="enrollmentKey"><xs:selector xpath="hmis:EntryRHY"/><xs:field xpath="hmis:ProjectEntryID"/></xs:keyref><xs:keyref name="exitExitHousingAssessmentKeyRef" refer="exitKey"><xs:selector xpath="hmis:ExitHousingAssessment"/><xs:field xpath="hmis:ExitID"/></xs:keyref><xs:keyref name="exitExitRHYKeyRef" refer="exitKey"><xs:selector xpath="hmis:ExitRHY"/><xs:field xpath="hmis:ExitID"/></xs:keyref><xs:keyref name="exitFamilyReunificationKeyRef" refer="exitKey"><xs:selector xpath="hmis:FamilyReunification"/><xs:field xpath="hmis:ExitID"/></xs:keyref><xs:keyref name="exitHousingAssessmentDispositionKeyRef" refer="exitKey"><xs:selector xpath="hmis:HousingAssessmentDisposition"/><xs:field xpath="hmis:ExitID"/></xs:keyref><xs:keyref name="inventoryCoCKeyRef" refer="cocKey"><xs:selector xpath="hmis:Inventory"/><xs:field xpath="hmis:CoCCode"/></xs:keyref><xs:keyref name="projectOrganizationKeyRef" refer="organizationKey"><xs:selector xpath="hmis:Project"/><xs:field xpath="hmis:OrganizationID"/></xs:keyref><xs:keyref name="cocProjectKeyRef" refer="projectKey"><xs:selector xpath="hmis:CoC"/><xs:field xpath="hmis:ProjectID"/></xs:keyref><xs:keyref name="projectEnrollmentKeyRef" refer="projectKey"><xs:selector xpath="hmis:Enrollment"/><xs:field xpath="hmis:ProjectID"/></xs:keyref><xs:keyref name="projectFunderKeyRef" refer="projectKey"><xs:selector xpath="hmis:Funder"/><xs:field xpath="hmis:ProjectID"/></xs:keyref><xs:keyref name="siteCoCKeyRef" refer="cocKey"><xs:selector xpath="hmis:Site"/><xs:field xpath="hmis:CoCCode"/></xs:keyref><xs:keyref name="clientVeteranInfoClientKeyRef" refer="clientKey"><xs:selector xpath="hmis:ClientVeteranInfo"/><xs:field xpath="hmis:PersonalID"/></xs:keyref></xs:element></xs:sequence><!--Testing if the source database is not an HMIS implementation (if SourceType <> 1), then SourceName may not be null.--><xs:assert test="if (hmis:SourceType/text()!='1') then boolean(hmis:SourceName) else true()"/><!--Testing if sourceType = 1, then SourceID may not be null --><xs:assert test="if (hmis:SourceType/text()='1') then boolean(hmis:SourceID) else true()"/></xs:complexType>
every $id in hmis:Client/hmis:PersonalID satisfies (fn:count(hmis:ClientVeteranInfo[hmis:PersonalID
= $id]) le 1)
every $id in hmis:Client/hmis:PersonalID satisfies (fn:count(hmis:Enrollment[hmis:PersonalID
= $id]) ge 1)
every $id in hmis:CoC/hmis:CoCCode satisfies (fn:count(hmis:EnrollmentCoC[hmis:CoCCode
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:ConnectionWithSOAR[hmis:ProjectEntryID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:Contact[hmis:ProjectEntryID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:DateOfEngagement[hmis:ProjectEntryID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:Disabilities[hmis:ProjectEntryID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:DomesticViolence[hmis:ProjectEntryID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:Employment[hmis:ProjectEntryID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:EnrollmentCoC[hmis:ProjectEntryID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:EntryRHY[hmis:ProjectEntryID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:EntrySSVF[hmis:ProjectEntryID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:Exit[hmis:ProjectEntryID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:HealthInsurance[hmis:ProjectEntryID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:HealthStatus[hmis:ProjectEntryID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:IncomeAndSources[hmis:ProjectEntryID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:MedicalAssistance[hmis:ProjectEntryID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:NonCashBenefits[hmis:ProjectEntryID
= $id]) ge 0)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:PathStatus[hmis:ProjectEntryID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:EntryRHSP[hmis:ProjectEntryID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:ResidentialMoveInDate[hmis:ProjectEntryID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:RHYBCPStatus[hmis:ProjectEntryID
= $id]) le 1)
every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:ServiceFAReferral[hmis:ProjectEntryID
= $id]) ge 0)
every $id in hmis:Exit/hmis:ExitID satisfies (fn:count(hmis:ExitHousingAssessment[hmis:ExitID
= $id]) le 1)
every $id in hmis:Exit/hmis:ExitID satisfies (fn:count(hmis:ExitRHY[hmis:ExitID =
$id]) le 1)
every $id in hmis:Exit/hmis:ExitID satisfies (fn:count(hmis:FamilyReunification[hmis:ExitID
= $id]) le 1)
every $id in hmis:Exit/hmis:ExitID satisfies (fn:count(hmis:HousingAssessmentDisposition[hmis:ExitID
= $id]) le 1)
every $id in hmis:Organization/hmis:OrganizationID satisfies (fn:count(hmis:Project[hmis:OrganizationID
= $id]) ge 0)
every $id in hmis:Project/hmis:ProjectID satisfies (fn:count(hmis:Affiliation[hmis:ProjectID
= $id]) ge 0)
every $id in hmis:Project/hmis:ProjectID satisfies (fn:count(hmis:CoC[hmis:ProjectID
= $id]) ge 1)
every $id in hmis:Project/hmis:ProjectID satisfies (fn:count(hmis:Funder[hmis:ProjectID
= $id]) ge 1)
every $id in hmis:Enrollment/hmis:HouseholdID satisfies (fn:count(hmis:Enrollment/hmis:RelationshipToHoH[text()=
'1'][../hmis:HouseholdID = $id] ) eq 1)
Source
<xs:complexType name="export"><xs:sequence><xs:element name="ExportID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Export's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ExportDate" type="xs:dateTime"><xs:annotation><xs:documentation xml:lang="en">Time the export was performed.</xs:documentation></xs:annotation></xs:element><xs:element name="ExportPeriod" type="hmis:dateRangeCapped"><xs:annotation><xs:documentation xml:lang="en">The date range bounding the data set being transmitted. Used with ExportPeriodType to clarify what the date range represents.</xs:documentation></xs:annotation></xs:element><xs:element name="ExportPeriodType" type="hmis:exportPeriodType"><xs:annotation><xs:documentation xml:lang="en">Pick one of the types to specify the definition of export period being used in ExportPeriod.</xs:documentation></xs:annotation></xs:element><xs:element name="ExportDirective" type="hmis:exportDirective"><xs:annotation><xs:documentation xml:lang="en">Select one of the ExportDirective choices to instruct the target as to how the data being transmitted should be handled.</xs:documentation></xs:annotation></xs:element><xs:choice maxOccurs="unbounded"><xs:element name="Affiliation" type="hmis:affiliation"/><xs:element name="Client" type="hmis:client"/><xs:element name="ConnectionWithSOAR" type="hmis:connectionWithSOAR"/><xs:element name="DateOfEngagement" type="hmis:dateOfEngagement"/><xs:element name="Disabilities" type="hmis:disabilities"/><xs:element name="DomesticViolence" type="hmis:domesticViolence"/><xs:element name="Education" type="hmis:education"/><xs:element name="Employment" type="hmis:employment"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.26</xs:documentation></xs:annotation></xs:element><xs:element name="Enrollment" type="hmis:enrollment"/><xs:element name="EnrollmentCoC" type="hmis:enrollmentCoC"/><xs:element name="Exit" type="hmis:exit"/><xs:element name="ExitHousingAssessment" type="hmis:exitHousingAssessment"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.19</xs:documentation></xs:annotation></xs:element><xs:element name="ExitRHY" type="hmis:exitRHY"/><xs:element name="Funder" type="hmis:funder"/><xs:element name="HealthInsurance" type="hmis:healthInsurance"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4</xs:documentation></xs:annotation></xs:element><xs:element name="HealthStatus" type="hmis:healthStatus"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.27</xs:documentation></xs:annotation></xs:element><xs:element name="HousingAssessmentDisposition" type="hmis:housingAssessmentDisposition"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.18</xs:documentation></xs:annotation></xs:element><xs:element name="IncomeAndSources" type="hmis:incomeAndSources"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2</xs:documentation></xs:annotation></xs:element><xs:element name="Inventory" type="hmis:inventory"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.7.</xs:documentation></xs:annotation></xs:element><xs:element name="MedicalAssistance" type="hmis:medicalAssistance"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.39</xs:documentation></xs:annotation></xs:element><xs:element name="NonCashBenefits" type="hmis:nonCashBenefits"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.3</xs:documentation></xs:annotation></xs:element><xs:element name="Organization" type="hmis:organization"/><xs:element name="PATHStatus" type="hmis:pathStatus"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.20</xs:documentation></xs:annotation></xs:element><xs:element name="EntrySSVF" type="hmis:entrySSVF"/><xs:element name="Project" type="hmis:project"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.</xs:documentation></xs:annotation></xs:element><xs:element name="CoC" type="hmis:coc"><xs:annotation><xs:documentation xml:lang="en"/></xs:annotation></xs:element><xs:element name="ResidentialMoveInDate" type="hmis:residentialMoveInDate"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.17</xs:documentation></xs:annotation></xs:element><xs:element name="RHYBCPStatus" type="hmis:rhyBCPStatus"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.22</xs:documentation></xs:annotation></xs:element><xs:element name="ServiceFAReferral" type="hmis:serviceFAReferral"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.14-4.16</xs:documentation></xs:annotation></xs:element><xs:element name="Site" type="hmis:site"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.8.</xs:documentation></xs:annotation></xs:element><xs:element name="ClientVeteranInfo" type="hmis:clientVeteranInfo"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.41</xs:documentation></xs:annotation></xs:element><xs:element name="EntryRHSP" type="hmis:entryRHSP"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.40.1.</xs:documentation></xs:annotation></xs:element><xs:element name="EntryRHY" type="hmis:entryRHY"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.</xs:documentation></xs:annotation></xs:element></xs:choice></xs:sequence><!--Cardinality Checking--><xs:assert test="every $id in hmis:Client/hmis:PersonalID satisfies (fn:count(hmis:ClientVeteranInfo[hmis:PersonalID = $id]) le 1)"/><xs:assert test="every $id in hmis:Client/hmis:PersonalID satisfies (fn:count(hmis:Enrollment[hmis:PersonalID = $id]) ge 1)"/><xs:assert test="every $id in hmis:CoC/hmis:CoCCode satisfies (fn:count(hmis:EnrollmentCoC[hmis:CoCCode = $id]) ge 0)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:ConnectionWithSOAR[hmis:ProjectEntryID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:Contact[hmis:ProjectEntryID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:DateOfEngagement[hmis:ProjectEntryID = $id]) le 1)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:Disabilities[hmis:ProjectEntryID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:DomesticViolence[hmis:ProjectEntryID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:Employment[hmis:ProjectEntryID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:EnrollmentCoC[hmis:ProjectEntryID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:EntryRHY[hmis:ProjectEntryID = $id]) le 1)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:EntrySSVF[hmis:ProjectEntryID = $id]) le 1)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:Exit[hmis:ProjectEntryID = $id]) le 1)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:HealthInsurance[hmis:ProjectEntryID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:HealthStatus[hmis:ProjectEntryID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:IncomeAndSources[hmis:ProjectEntryID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:MedicalAssistance[hmis:ProjectEntryID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:NonCashBenefits[hmis:ProjectEntryID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:PathStatus[hmis:ProjectEntryID = $id]) le 1)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:EntryRHSP[hmis:ProjectEntryID = $id]) le 1)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:ResidentialMoveInDate[hmis:ProjectEntryID = $id]) le 1)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:RHYBCPStatus[hmis:ProjectEntryID = $id]) le 1)"/><xs:assert test="every $id in hmis:Enrollment/hmis:ProjectEntryID satisfies (fn:count(hmis:ServiceFAReferral[hmis:ProjectEntryID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Exit/hmis:ExitID satisfies (fn:count(hmis:ExitHousingAssessment[hmis:ExitID = $id]) le 1)"/><xs:assert test="every $id in hmis:Exit/hmis:ExitID satisfies (fn:count(hmis:ExitRHY[hmis:ExitID = $id]) le 1)"/><xs:assert test="every $id in hmis:Exit/hmis:ExitID satisfies (fn:count(hmis:FamilyReunification[hmis:ExitID = $id]) le 1)"/><xs:assert test="every $id in hmis:Exit/hmis:ExitID satisfies (fn:count(hmis:HousingAssessmentDisposition[hmis:ExitID = $id]) le 1)"/><xs:assert test="every $id in hmis:Organization/hmis:OrganizationID satisfies (fn:count(hmis:Project[hmis:OrganizationID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Project/hmis:ProjectID satisfies (fn:count(hmis:Affiliation[hmis:ProjectID = $id]) ge 0)"/><xs:assert test="every $id in hmis:Project/hmis:ProjectID satisfies (fn:count(hmis:CoC[hmis:ProjectID = $id]) ge 1)"/><xs:assert test="every $id in hmis:Project/hmis:ProjectID satisfies (fn:count(hmis:Funder[hmis:ProjectID = $id]) ge 1)"/><!-- Checking that there is only one Head of Household per Household enrolled --><xs:assert test="every $id in hmis:Enrollment/hmis:HouseholdID satisfies (fn:count(hmis:Enrollment/hmis:RelationshipToHoH[text()= '1'][../hmis:HouseholdID = $id] ) eq 1)"/></xs:complexType>
<xs:complexType name="dateRangeCapped"><xs:annotation><xs:documentation xml:lang="en">A date range, both start and end dates are required.</xs:documentation></xs:annotation><xs:sequence><xs:element name="StartDate" type="xs:dateTime"/><xs:element name="EndDate" type="xs:dateTime"/></xs:sequence></xs:complexType>
Exported data sets with an ExportPeriodType of ‘updated’ will include all records with a dateCreated, dateUpdated, or a dateDeleted that falls between the Export.StartDate and the Export.EndDate.
enumeration
effective
Exported data sets with an ExportPeriod type of ‘effective’ will include all enrollment data, along with associated client and project descriptor data, where the informationDate (or other effective date such as Project.EntryDate, Project.ExitDate, ContactDate, etc.) falls between the Export.StartDate and the Export.EndDate.
enumeration
reportingPeriod
‘reportingPeriod’ exports include all records needed for reporting on clients and enrollments active in the export period. This will include all records in Enrollments (regardless of informationDate, dateCreated, dateUpdated, etc.), client files, and project descriptor files associated with a ProjectEntryID where: ProjectEntryDate is on or before the Export.EndDate; Project.ExitDate is null OR Project.ExitDate is on or after the Export.StartDate; ProjectID is associated with a project selected by a user for export OR the user did not choose to filter the export by Project; A CoCCode associated with the ProjectEntryID matches a CoCCode selected by a user for export OR the user did not choose to filter the export by CoCCode.
enumeration
other
The ‘other’ type of ExportPeriodType is used to identify exports in which records were selected based upon parameters mutually agreed upon by the sender and recipient of the XML data."
<xs:simpleType name="exportPeriodType"><xs:restriction base="xs:string"><xs:enumeration value="updated"><xs:annotation><xs:documentation xml:lang="en">Exported data sets with an ExportPeriodType of ‘updated’ will include all records with a dateCreated, dateUpdated, or a dateDeleted that falls between the Export.StartDate and the Export.EndDate.</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="effective"><xs:annotation><xs:documentation xml:lang="en">Exported data sets with an ExportPeriod type of ‘effective’ will include all enrollment data, along with associated client and project descriptor data, where the informationDate (or other effective date such as Project.EntryDate, Project.ExitDate, ContactDate, etc.) falls between the Export.StartDate and the Export.EndDate.</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="reportingPeriod"><xs:annotation><xs:documentation xml:lang="en">‘reportingPeriod’ exports include all records needed for reporting on clients and enrollments active in the export period. This will include all records in Enrollments (regardless of informationDate, dateCreated, dateUpdated, etc.), client files, and project descriptor files associated with a ProjectEntryID where: ProjectEntryDate is on or before the Export.EndDate; Project.ExitDate is null OR Project.ExitDate is on or after the Export.StartDate; ProjectID is associated with a project selected by a user for export OR the user did not choose to filter the export by Project; A CoCCode associated with the ProjectEntryID matches a CoCCode selected by a user for export OR the user did not choose to filter the export by CoCCode.</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="other"><xs:annotation><xs:documentation xml:lang="en">The ‘other’ type of ExportPeriodType is used to identify exports in which records were selected based upon parameters mutually agreed upon by the sender and recipient of the XML data."</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
<xs:simpleType name="exportDirective"><xs:restriction base="xs:string"><xs:enumeration value="deltaRefresh"><xs:annotation><xs:documentation xml:lang="en">The data contained in this file is meant to be synchronized with an existing data set.</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="fullRefresh"><xs:annotation><xs:documentation xml:lang="en">The data contained in this file is meant to replace an existing data set for the export period.</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="other"><xs:annotation><xs:documentation xml:lang="en">The data contained in this file were selected based upon parameters mutually agreed upon by the sender and recipient of the XML data.</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
Name Data Quality 1 = Full name reported 2 = Partial, street name, or code name reported 8 = Client doesn’t know 9 = Client refused 99 = Data not collected
<xs:simpleType name="nameDataQuality"><xs:annotation><xs:documentation xml:lang="en">Name Data Quality 1 = Full name reported 2 = Partial, street name, or code name reported 8 = Client doesn’t know 9 = Client refused 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Full name reported</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Partial, street name, or code name reported</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="8"><xs:annotation><xs:documentation xml:lang="en">Client doesn’t know</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="9"><xs:annotation><xs:documentation xml:lang="en">Client refused</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
<xs:simpleType name="dobDataQuality"><xs:annotation><xs:documentation xml:lang="en">Name Data Quality 1 = Full DOB reported 2 = Approximate or partial DOB reported 8 = Client doesn’t know 9 = Client refused 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Full DOB reported</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Approximate or partial DOB reported</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="8"><xs:annotation><xs:documentation xml:lang="en">Client doesn’t know</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="9"><xs:annotation><xs:documentation xml:lang="en">Client refused</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
Applicable to:Gender 0 = Female1 = Male 2 = Transgender male to female 3 = Transgender female to male 4 = Doesn’t identify as male, female, or transgender 8 = Client doesn’t know 9 = Client refused 99 Data not collected
<xs:simpleType name="gender"><xs:annotation><xs:documentation xml:lang="en">Applicable to: Gender 0 = Female 1 = Male 2 = Transgender male to female 3 = Transgender female to male 4 = Doesn’t identify as male, female, or transgender 8 = Client doesn’t know 9 = Client refused 99 Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="0"><xs:annotation><xs:documentation xml:lang="en">Female</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Male</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Transgender male to female</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Transgender female to male</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Doesn’t identify as male, female, or transgender</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="8"><xs:annotation><xs:documentation xml:lang="en">Client doesn't know</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="9"><xs:annotation><xs:documentation xml:lang="en">Client refused</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
Race1 = American Indian or Alaska Native 2 = Asian 3 = Black or African American 4 = Native Hawaiian or Other Pacific Islander 5 = White 8 = Client doesn’t know 9 = Client refused 99 = Data not collected
<xs:simpleType name="race"><xs:annotation><xs:documentation xml:lang="en">Race 1 = American Indian or Alaska Native 2 = Asian 3 = Black or African American 4 = Native Hawaiian or Other Pacific Islander 5 = White 8 = Client doesn’t know 9 = Client refused 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">American Indian or Alaska Native</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Asian</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Black or African American</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Native Hawaiian or Other Pacific Islander</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="5"><xs:annotation><xs:documentation xml:lang="en">White</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="8"><xs:annotation><xs:documentation xml:lang="en">Client doesn’t know</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="9"><xs:annotation><xs:documentation xml:lang="en">Client refused</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:complexType name="dateOfEngagement"><xs:sequence><xs:element name="DateOfEngagementID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the DateOfEngagement's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="DateOfEngagement" type="xs:date"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.13.1.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/></xs:complexType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:TCellCountAvailable) then boolean(hmis:DisabilityType/text()='8') else true()
if (hmis:TCellCountAvailable/text()='1') then boolean(hmis:TCellCount) else (if (not(hmis:TCellCountAvailable/text()='1'))
then (not(boolean(hmis:TCellCount))) else false())
if (hmis:TCellCount) then boolean(hmis:TCellSource) else (if (not(hmis:TCellCount))
then (not(boolean(hmis:TCellSource))) else false())
if (hmis:ViralLoadAvailable) then boolean(hmis:DisabilityType/text()='8') else true()
if (hmis:ViralLoadAvailable/text()='1') then boolean(hmis:ViralLoad) else (if (not(hmis:ViralLoadAvailable/text()='1'))
then (not(boolean(hmis:ViralLoad))) else false())
if (hmis:ViralLoad) then boolean(hmis:ViralLoadSource) else (if (not(hmis:ViralLoad))
then (not(boolean(hmis:ViralLoadSource))) else false())
Source
<xs:complexType name="disabilities"><xs:sequence><xs:element name="DisabilitiesID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Exit's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="DisabilityType" type="hmis:disabilityType"><xs:annotation><xs:documentation xml:lang="en">The permissible values correspond to the decimal values of the corresponding disability types. 4.5 Physical Disability is "5" and 4.10 Substance Abuse is "10".</xs:documentation></xs:annotation></xs:element><xs:element name="DisabilityResponse" type="xs:nonNegativeInteger"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.5-4.10, Response #2. Permissable values vary depending on which disability type is declared. The values are contined with "Field and Response(s) 2" within 4.5 through 4.10.</xs:documentation></xs:annotation></xs:element><xs:element name="IndefiniteAndImpairsIndependence" type="hmis:fiveValDKRefused"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.5-4.10, Response #2A.</xs:documentation></xs:annotation></xs:element><xs:element name="DocumentationOnFile" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.5-4.10, Response #2B.</xs:documentation></xs:annotation></xs:element><xs:element name="ReceivingServices" type="hmis:fiveValDKRefused"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.5-4.10, Response #2C.</xs:documentation></xs:annotation></xs:element><xs:element name="PATHHowConfirmed" type="hmis:pathHowConfirmed" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.9-4.10, Response #2D.</xs:documentation></xs:annotation></xs:element><xs:element name="PATHSMIInformation" type="hmis:pathSMIInformation" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.9, Response #2E.</xs:documentation></xs:annotation></xs:element><xs:element name="TCellCountAvailable" type="hmis:fiveValDKRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.47 #2.</xs:documentation></xs:annotation></xs:element><xs:element name="TCellCount" type="hmis:tCellCount" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.47 A.</xs:documentation></xs:annotation></xs:element><xs:element name="TCellSource" type="hmis:tCellOrViralLoadSource" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.47.B.</xs:documentation></xs:annotation></xs:element><xs:element name="ViralLoadAvailable" type="hmis:viralLoadAvailable" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.47.3.</xs:documentation></xs:annotation></xs:element><xs:element name="ViralLoad" type="hmis:viralLoad" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.47.C.</xs:documentation></xs:annotation></xs:element><xs:element name="ViralLoadSource" type="hmis:tCellOrViralLoadSource" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.47 D.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attribute ref="hmis:dataCollectionStage" use="required"/><xs:attribute ref="hmis:informationDate" use="required"/><xs:attributeGroup ref="hmis:baseMetaData"/><!--Testing if DisabilityType is 8, before allowing use of TCellCountAvailable--><xs:assert test="if (hmis:TCellCountAvailable) then boolean(hmis:DisabilityType/text()='8') else true()"/><!--Testing if TCellCountAvailable is 1, before allowing use of TCellCount--><xs:assert test="if (hmis:TCellCountAvailable/text()='1') then boolean(hmis:TCellCount) else (if (not(hmis:TCellCountAvailable/text()='1')) then (not(boolean(hmis:TCellCount))) else false())"/><!--Testing if TCellCount is not null, before allowing use of TCellSource--><xs:assert test="if (hmis:TCellCount) then boolean(hmis:TCellSource) else (if (not(hmis:TCellCount)) then (not(boolean(hmis:TCellSource))) else false())"/><!--Testing if DisabilityType is 8, before allowing use of ViralLoadAvailable--><xs:assert test="if (hmis:ViralLoadAvailable) then boolean(hmis:DisabilityType/text()='8') else true()"/><!--Testing if ViralLoadAvailable is 1, before allowing use of ViralLoad--><xs:assert test="if (hmis:ViralLoadAvailable/text()='1') then boolean(hmis:ViralLoad) else (if (not(hmis:ViralLoadAvailable/text()='1')) then (not(boolean(hmis:ViralLoad))) else false())"/><!--Testing if ViralLoad is not null, before allowing use of ViralLoadSource--><xs:assert test="if (hmis:ViralLoad) then boolean(hmis:ViralLoadSource) else (if (not(hmis:ViralLoad)) then (not(boolean(hmis:ViralLoadSource))) else false())"/></xs:complexType>
How confirmed1 = Unconfirmed; presumptive or self-report2 = Confirmed through assessment and clinical evaluation3 = Confirmed by prior evaluation or clinical records99 = Data not collected
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
1
Unconfirmed; presumptive or self-report
enumeration
2
Confirmed through assessment and clinical evaluation
<xs:simpleType name="pathHowConfirmed"><xs:annotation><xs:documentation xml:lang="en">How confirmed 1 = Unconfirmed; presumptive or self-report 2 = Confirmed through assessment and clinical evaluation 3 = Confirmed by prior evaluation or clinical records 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Unconfirmed; presumptive or self-report</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Confirmed through assessment and clinical evaluation</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Confirmed by prior evaluation or clinical records</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
How Confirmed Response0 = No1 = Unconfirmed; presumptive or self-report2 = Confirmed through assessment and clinical evaluation3 = Confirmed by prior evaluation or clinical records8 = Client doesn’t know9 = Client refused99 = Data not collected
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
0
No
enumeration
1
Unconfirmed; presumptive or self-report
enumeration
2
Confirmed through assessment and clinical evaluation
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:DomesticViolenceVictim/text()='1') then boolean(hmis:CurrentlyFleeing) else
(if (not(hmis:DomesticViolenceVictim/text()='1')) then (not(boolean(hmis:CurrentlyFleeing)))
else false())
Source
<xs:complexType name="domesticViolence"><xs:sequence><xs:element name="DomesticViolenceID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the DomesticViolence's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="DomesticViolenceVictim" type="hmis:fiveValDKRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.11.2.</xs:documentation></xs:annotation></xs:element><xs:element name="WhenOccurred" type="hmis:whenOccurred" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.11.A.</xs:documentation></xs:annotation></xs:element><xs:element name="CurrentlyFleeing" type="hmis:fiveValDKRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.11.B.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attribute ref="hmis:dataCollectionStage" use="required"/><xs:attribute ref="hmis:informationDate" use="required"/><xs:attributeGroup ref="hmis:baseMetaData"/><!--Testing if DomesticViolenceVictim is 1, before allowing use of CurrentlyFleeing--><xs:assert test="if (hmis:DomesticViolenceVictim/text()='1') then boolean(hmis:CurrentlyFleeing) else (if (not(hmis:DomesticViolenceVictim/text()='1')) then (not(boolean(hmis:CurrentlyFleeing))) else false())"/></xs:complexType>
If Yes for “Domestic Violence Victim/Survivor”When experience occurredResponse(s)1 = Within the past three months2 = Three to six months ago (excluding six months exactly)3 = Six months to one year ago (excluding one year exactly)4 = One year ago or more8 = Client doesn’t know9 = Client refused99 = Data not collected
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
1
Within the past three months
enumeration
2
Three to six months ago (excluding six months exactly)
enumeration
3
Six months to one year ago (excluding one year exactly)
<xs:simpleType name="whenOccurred"><xs:annotation><xs:documentation xml:lang="en">If Yes for “Domestic Violence Victim/Survivor” When experience occurredResponse(s) 1 = Within the past three months 2 = Three to six months ago (excluding six months exactly) 3 = Six months to one year ago (excluding one year exactly) 4 = One year ago or more 8 = Client doesn’t know 9 = Client refused 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Within the past three months</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Three to six months ago (excluding six months exactly)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Six months to one year ago (excluding one year exactly)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">One year ago or more</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="8"><xs:annotation><xs:documentation xml:lang="en">Client doesn’t know</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="9"><xs:annotation><xs:documentation xml:lang="en">Client refused</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
Last Grade Completed1 = Less than Grade 52 = Grades 5-63 = Grades 7-84 = Grades 9-115 =Grade 126 = School program does not have grade levels7 = GED10 = Some college11 = Associate’s degree12 = Bachelor’s degree13 = Graduate degree14 = Vocational certification8 = Client doesn’t know9 = Client refused99 = Data not collected
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:simpleType name="notEmployedReason"><xs:annotation><xs:documentation xml:lang="en">If No for “Employed” Why Not Employed 1 = Looking for work 2 = Unable to work 3 = Not looking for work 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Looking for work</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Unable to work</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Not looking for work</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:TimesHomelessPastThreeYears/text()='1' or hmis:TimesHomelessPastThreeYears/text()='2'
or hmis:TimesHomelessPastThreeYears/text()='3' or hmis:TimesHomelessPastThreeYears/text()='4')
then boolean(hmis:MonthsHomelessPastThreeYears) else (if (not(hmis:TimesHomelessPastThreeYears/text()='1'
or hmis:TimesHomelessPastThreeYears/text()='2' or hmis:TimesHomelessPastThreeYears/text()='3'
or hmis:TimesHomelessPastThreeYears/text()='4')) then (not(boolean(hmis:MonthsHomelessPastThreeYears)))
else false())
Source
<xs:complexType name="enrollment"><xs:sequence><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Enrollment's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="PersonalID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Client's ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the associated Project's ID</xs:documentation></xs:annotation></xs:element><xs:element name="EntryDate" type="xs:date"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.10.</xs:documentation></xs:annotation></xs:element><xs:element name="HouseholdID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.14.</xs:documentation></xs:annotation></xs:element><xs:element name="RelationshipToHoH" type="hmis:relationshipToHoH"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.15.</xs:documentation></xs:annotation></xs:element><xs:element name="ResidencePrior" type="hmis:residencePrior" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.917.1.</xs:documentation></xs:annotation></xs:element><xs:element name="ResidencePriorLengthOfStay" type="hmis:residencePriorLengthOfStay" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.917.2.</xs:documentation></xs:annotation></xs:element><xs:element name="LOSUnderThreshold" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.917.2A/2B.</xs:documentation></xs:annotation></xs:element><xs:element name="PreviousStreetESSH" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.917.2C.</xs:documentation></xs:annotation></xs:element><xs:element name="DateToStreetESSH" type="xs:date" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.917.3.</xs:documentation></xs:annotation></xs:element><xs:element name="TimesHomelessPastThreeYears" type="hmis:timesHomelessPastThreeYears" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.917.4.</xs:documentation></xs:annotation></xs:element><xs:element name="MonthsHomelessPastThreeYears" type="hmis:monthsHomelessPastThreeYears" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.917.5.</xs:documentation></xs:annotation></xs:element><xs:element name="DisablingCondition" type="hmis:fiveValDKRefused"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.8.</xs:documentation></xs:annotation></xs:element><xs:element name="HousingStatus" type="hmis:housingStatus" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.1.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/><!--Testing if TimesHomelessPastThreeYears is 1-4, before allowing use of MonthsHomelessPastThreeYears--><xs:assert test="if (hmis:TimesHomelessPastThreeYears/text()='1' or hmis:TimesHomelessPastThreeYears/text()='2' or hmis:TimesHomelessPastThreeYears/text()='3' or hmis:TimesHomelessPastThreeYears/text()='4') then boolean(hmis:MonthsHomelessPastThreeYears) else (if (not(hmis:TimesHomelessPastThreeYears/text()='1' or hmis:TimesHomelessPastThreeYears/text()='2' or hmis:TimesHomelessPastThreeYears/text()='3' or hmis:TimesHomelessPastThreeYears/text()='4')) then (not(boolean(hmis:MonthsHomelessPastThreeYears))) else false())"/></xs:complexType>
RelationshipToHeadOfHousehold1 = Self (head of household) 2 = Head of household’s child 3 = Head of household’s spouse or partner4 = Head of household’s other relation member (other relation to head of household) 5 = Other: non-relation member
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
1
Self (head of household)
enumeration
2
Head of household’s child
enumeration
3
Head of household’s spouse or partner
enumeration
4
Head of household’s other relation member (other relation to head of household)
<xs:simpleType name="relationshipToHoH"><xs:annotation><xs:documentation xml:lang="en">RelationshipToHeadOfHousehold 1 = Self (head of household) 2 = Head of household’s child 3 = Head of household’s spouse or partner 4 = Head of household’s other relation member (other relation to head of household) 5 = Other: non-relation member</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Self (head of household)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Head of household’s child</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Head of household’s spouse or partner</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Head of household’s other relation member (other relation to head of household)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="5"><xs:annotation><xs:documentation xml:lang="en">Other: non-relation member</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
Residence Type1 = Emergency shelter, including hotel or motel paid for with emergency shelter voucher2 = Transitional housing for homeless persons (including homeless youth)3 = Permanent housing for formerly homeless persons (such as: CoC project; HUD legacy programs; or HOPWA PH) 4 = Psychiatric hospital or other psychiatric facility5 = Substance abuse treatment facility or detox center6 = Hospital or other residential non-psychiatric medical facility7 = Jail, prison or juvenile detention facility8 = Client doesn’t know9 = Client refused12 = Staying or living in a family member’s room, apartment or house 13 = Staying or living in a friend’s room, apartment or house14 = Hotel or motel paid for without emergency shelter voucher 15 = Foster care home or foster care group home 16 = Place not meant for habitation (e.g., a vehicle, an abandoned building, bus/train/subway station/airport or anywhere outside)17 = Other18 = Safe Haven19 = Rental by client, with VASH subsidy20 = Rental by client, with other ongoing housing subsidy21 = Owned by client, with ongoing housing subsidy 22 = Rental by client, no ongoing housing subsidy23 = Owned by client, no ongoing housing subsidy 24 = Long-term care facility or nursing home25 = Rental by client, with GPD TIP subsidy26 = Residential project or halfway house with no homeless criteria27 = Interim housing99 = Data not collected
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
1
Emergency shelter, including hotel or motel paid for with emergency shelter voucher
enumeration
2
Transitional housing for homeless persons (including homeless youth)
enumeration
3
Permanent housing for formerly homeless persons (such as: CoC project; HUD legacy programs; or HOPWA PH)
enumeration
4
Psychiatric hospital or other psychiatric facility
enumeration
5
Substance abuse treatment facility or detox center
enumeration
6
Hospital or other residential non-psychiatric medical facility
enumeration
7
Jail, prison or juvenile detention facility
enumeration
8
Client doesn’t know
enumeration
9
Client refused
enumeration
12
Staying or living in a family member’s room, apartment or house
enumeration
13
Staying or living in a friend’s room, apartment or house
enumeration
14
Hotel or motel paid for without emergency shelter voucher
enumeration
15
Foster care home or foster care group home
enumeration
16
Place not meant for habitation (e.g., a vehicle, an abandoned building, bus/train/subway station/airport or anywhere outside)
enumeration
17
Other
enumeration
18
Safe Haven
enumeration
19
Rental by client, with VASH subsidy
enumeration
20
Rental by client, with other ongoing housing subsidy
enumeration
21
Owned by client, with ongoing housing subsidy
enumeration
22
Rental by client, no ongoing housing subsidy
enumeration
23
Owned by client, no ongoing housing subsidy
enumeration
24
Long-term care facility or nursing home
enumeration
25
Rental by client, with GPD TIP subsidy
enumeration
26
Residential project or halfway house with no homeless criteria
<xs:simpleType name="residencePrior"><xs:annotation><xs:documentation xml:lang="en">Residence Type 1 = Emergency shelter, including hotel or motel paid for with emergency shelter voucher 2 = Transitional housing for homeless persons (including homeless youth) 3 = Permanent housing for formerly homeless persons (such as: CoC project; HUD legacy programs; or HOPWA PH) 4 = Psychiatric hospital or other psychiatric facility 5 = Substance abuse treatment facility or detox center 6 = Hospital or other residential non-psychiatric medical facility 7 = Jail, prison or juvenile detention facility 8 = Client doesn’t know 9 = Client refused 12 = Staying or living in a family member’s room, apartment or house 13 = Staying or living in a friend’s room, apartment or house 14 = Hotel or motel paid for without emergency shelter voucher 15 = Foster care home or foster care group home 16 = Place not meant for habitation (e.g., a vehicle, an abandoned building, bus/train/subway station/airport or anywhere outside) 17 = Other 18 = Safe Haven 19 = Rental by client, with VASH subsidy 20 = Rental by client, with other ongoing housing subsidy 21 = Owned by client, with ongoing housing subsidy 22 = Rental by client, no ongoing housing subsidy 23 = Owned by client, no ongoing housing subsidy 24 = Long-term care facility or nursing home 25 = Rental by client, with GPD TIP subsidy 26 = Residential project or halfway house with no homeless criteria 27 = Interim housing 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Emergency shelter, including hotel or motel paid for with emergency shelter voucher</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Transitional housing for homeless persons (including homeless youth)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Permanent housing for formerly homeless persons (such as: CoC project; HUD legacy programs; or HOPWA PH)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Psychiatric hospital or other psychiatric facility</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="5"><xs:annotation><xs:documentation xml:lang="en">Substance abuse treatment facility or detox center</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="6"><xs:annotation><xs:documentation xml:lang="en">Hospital or other residential non-psychiatric medical facility</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="7"><xs:annotation><xs:documentation xml:lang="en">Jail, prison or juvenile detention facility</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="8"><xs:annotation><xs:documentation xml:lang="en">Client doesn’t know</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="9"><xs:annotation><xs:documentation xml:lang="en">Client refused</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="12"><xs:annotation><xs:documentation xml:lang="en">Staying or living in a family member’s room, apartment or house</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="13"><xs:annotation><xs:documentation xml:lang="en">Staying or living in a friend’s room, apartment or house</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="14"><xs:annotation><xs:documentation xml:lang="en">Hotel or motel paid for without emergency shelter voucher</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="15"><xs:annotation><xs:documentation xml:lang="en">Foster care home or foster care group home</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="16"><xs:annotation><xs:documentation xml:lang="en">Place not meant for habitation (e.g., a vehicle, an abandoned building, bus/train/subway station/airport or anywhere outside)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="17"><xs:annotation><xs:documentation xml:lang="en">Other</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="18"><xs:annotation><xs:documentation xml:lang="en">Safe Haven</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="19"><xs:annotation><xs:documentation xml:lang="en">Rental by client, with VASH subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="20"><xs:annotation><xs:documentation xml:lang="en">Rental by client, with other ongoing housing subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="21"><xs:annotation><xs:documentation xml:lang="en">Owned by client, with ongoing housing subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="22"><xs:annotation><xs:documentation xml:lang="en">Rental by client, no ongoing housing subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="23"><xs:annotation><xs:documentation xml:lang="en">Owned by client, no ongoing housing subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="24"><xs:annotation><xs:documentation xml:lang="en">Long-term care facility or nursing home</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="25"><xs:annotation><xs:documentation xml:lang="en">Rental by client, with GPD TIP subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="26"><xs:annotation><xs:documentation xml:lang="en">Residential project or halfway house with no homeless criteria</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="27"><xs:annotation><xs:documentation xml:lang="en">Interim housing</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
Length of Stay in Previous Place2 = One week or more, but less than one month3 = One month or more, but less than 90 days4 = 90 days or more but less than one year5 = One year or longer 8 = Client doesn’t know 9 = Client refused10 = One night or less11 = Two to six nights 99 = Data not collected
<xs:simpleType name="residencePriorLengthOfStay"><xs:annotation><xs:documentation xml:lang="en">Length of Stay in Previous Place 2 = One week or more, but less than one month 3 = One month or more, but less than 90 days 4 = 90 days or more but less than one year 5 = One year or longer 8 = Client doesn’t know 9 = Client refused 10 = One night or less 11 = Two to six nights 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">One week or more, but less than one month</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">One month or more, but less than 90 days</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">90 days or more but less than one year</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="5"><xs:annotation><xs:documentation xml:lang="en">One year or longer</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="8"><xs:annotation><xs:documentation xml:lang="en">Client doesn’t know</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="9"><xs:annotation><xs:documentation xml:lang="en">Client refused</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="10"><xs:annotation><xs:documentation xml:lang="en">One night or less</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="11"><xs:annotation><xs:documentation xml:lang="en">Two to six nights</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
Number of Times the Client has been Homeless in the Past Three Years 1 = One time2 = Two times3 = Three times4 = Four or more times8 = Client doesn’t know9 = Client refused99 = Data not collected
<xs:simpleType name="timesHomelessPastThreeYears"><xs:annotation><xs:documentation xml:lang="en">Number of Times the Client has been Homeless in the Past Three Years 1 = One time 2 = Two times 3 = Three times 4 = Four or more times 8 = Client doesn’t know 9 = Client refused 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">One time</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Two times</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Three times</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Four or more times</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="8"><xs:annotation><xs:documentation xml:lang="en">Client doesn’t know</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="9"><xs:annotation><xs:documentation xml:lang="en">Client refused</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
Total Number of Months Homeless in the Past Three Years 101 – 112 = 1 to 12 months (with a leading "1")113 = More than 12 months 8 = Client doesn’t know 9 = Client refused 99 = Data not collected
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:complexType name="enrollmentCoC"><xs:sequence><xs:element name="EnrollmentCoCID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the EnrollmentCoC's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment's ID</xs:documentation></xs:annotation></xs:element><xs:element name="HouseholdID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Household ID, as a convenience</xs:documentation></xs:annotation></xs:element><xs:element name="CoCCode" type="hmis:cocCode"><xs:annotation><xs:documentation xml:lang="en">Key reference to the CoC's ID</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attribute ref="hmis:dataCollectionStage" use="required"/><xs:attribute ref="hmis:informationDate" use="required"/><xs:attributeGroup ref="hmis:baseMetaData"/></xs:complexType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:Destination/text()='17') then boolean(hmis:OtherDestination) else (if (not(hmis:Destination/text()='17'))
then (not(boolean(hmis:OtherDestination))) else false())
Source
<xs:complexType name="exit"><xs:sequence><xs:element name="ExitID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Exit's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="ExitDate" type="xs:date"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.11.1.</xs:documentation></xs:annotation></xs:element><xs:element name="Destination" type="hmis:destination" minOccurs="1"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.12.1.</xs:documentation></xs:annotation></xs:element><xs:element name="OtherDestination" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 3.12.1A.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/><!--Testing if Destination is 17, before allowing use of OtherDestination--><xs:assert test="if (hmis:Destination/text()='17') then boolean(hmis:OtherDestination) else (if (not(hmis:Destination/text()='17')) then (not(boolean(hmis:OtherDestination))) else false())"/></xs:complexType>
24 = Deceased1 = Emergency shelter, including hotel or motel paid for with emergency shelter voucher15 = Foster care home or foster care group home6 = Hospital or other residential non-psychiatric medical facility14 = Hotel or motel paid for without emergency shelter voucher7 = Jail, prison or juvenile detention facility25 = Long-term care facility or nursing home26 = Moved from one HOPWA funded project to HOPWA PH27 = Moved from one HOPWA funded project to HOPWA TH11 = Owned by client, no ongoing housing subsidy21 = Owned by client, with ongoing housing subsidy3 = Permanent housing for formerly homeless persons (such as: CoC project; or HUD legacy programs; or HOPWA PH)16 = Place not meant for habitation (e.g., a vehicle, an abandoned building, bus/train/subway station/airport or anywhere outside)4 = Psychiatric hospital or other psychiatric facility10 = Rental by client, no ongoing housing subsidy19 = Rental by client, with VASH housing subsidy28 = Rental by client, with GPD TIP housing subsidy20 = Rental by client, with other ongoing housing subsidy29 = Residential project or halfway house with no homeless criteria18 = Safe Haven22 = Staying or living with family, permanent tenure12 = Staying or living with family, temporary tenure (e.g., room, apartment or house)23 = Staying or living with friends, permanent tenure13 = Staying or living with friends, temporary tenure (e.g., room apartment or house)5 = Substance abuse treatment facility or detox center2 = Transitional housing for homeless persons (including homeless youth)17 = Other30 = No exit interview completed8 = Client doesn’t know9 = Client refused99 = Data not collected
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
24
Deceased
enumeration
1
Emergency shelter, including hotel or motel paid for with emergency shelter voucher
enumeration
15
Foster care home or foster care group home
enumeration
6
Hospital or other residential non-psychiatric medical facility
enumeration
14
Hotel or motel paid for without emergency shelter voucher
enumeration
7
Jail, prison or juvenile detention facility
enumeration
25
Long-term care facility or nursing home
enumeration
26
Moved from one HOPWA funded project to HOPWA PH
enumeration
27
Moved from one HOPWA funded project to HOPWA TH
enumeration
11
Owned by client, no ongoing housing subsidy
enumeration
21
Owned by client, with ongoing housing subsidy
enumeration
3
Permanent housing for formerly homeless persons (such as: CoC project; or HUD legacy programs; or HOPWA PH)
enumeration
16
Place not meant for habitation (e.g., a vehicle, an abandoned building, bus/train/subway station/airport or anywhere outside)
enumeration
4
Psychiatric hospital or other psychiatric facility
enumeration
10
Rental by client, no ongoing housing subsidy
enumeration
19
Rental by client, with VASH housing subsidy
enumeration
28
Rental by client, with GPD TIP housing subsidy
enumeration
20
Rental by client, with other ongoing housing subsidy
enumeration
29
Residential project or halfway house with no homeless criteria
enumeration
18
Safe Haven
enumeration
22
Staying or living with family, permanent tenure
enumeration
12
Staying or living with family, temporary tenure (e.g., room, apartment or house)
enumeration
23
Staying or living with friends, permanent tenure
enumeration
13
Staying or living with friends, temporary tenure (e.g., room apartment or house)
enumeration
5
Substance abuse treatment facility or detox center
enumeration
2
Transitional housing for homeless persons (including homeless youth)
<xs:simpleType name="destination"><xs:annotation><xs:documentation xml:lang="en">24 = Deceased 1 = Emergency shelter, including hotel or motel paid for with emergency shelter voucher 15 = Foster care home or foster care group home 6 = Hospital or other residential non-psychiatric medical facility 14 = Hotel or motel paid for without emergency shelter voucher 7 = Jail, prison or juvenile detention facility 25 = Long-term care facility or nursing home 26 = Moved from one HOPWA funded project to HOPWA PH 27 = Moved from one HOPWA funded project to HOPWA TH 11 = Owned by client, no ongoing housing subsidy 21 = Owned by client, with ongoing housing subsidy 3 = Permanent housing for formerly homeless persons (such as: CoC project; or HUD legacy programs; or HOPWA PH) 16 = Place not meant for habitation (e.g., a vehicle, an abandoned building, bus/train/subway station/airport or anywhere outside) 4 = Psychiatric hospital or other psychiatric facility 10 = Rental by client, no ongoing housing subsidy 19 = Rental by client, with VASH housing subsidy 28 = Rental by client, with GPD TIP housing subsidy 20 = Rental by client, with other ongoing housing subsidy 29 = Residential project or halfway house with no homeless criteria 18 = Safe Haven 22 = Staying or living with family, permanent tenure 12 = Staying or living with family, temporary tenure (e.g., room, apartment or house) 23 = Staying or living with friends, permanent tenure 13 = Staying or living with friends, temporary tenure (e.g., room apartment or house) 5 = Substance abuse treatment facility or detox center 2 = Transitional housing for homeless persons (including homeless youth) 17 = Other 30 = No exit interview completed 8 = Client doesn’t know 9 = Client refused 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="24"><xs:annotation><xs:documentation xml:lang="en">Deceased</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Emergency shelter, including hotel or motel paid for with emergency shelter voucher</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="15"><xs:annotation><xs:documentation xml:lang="en">Foster care home or foster care group home</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="6"><xs:annotation><xs:documentation xml:lang="en">Hospital or other residential non-psychiatric medical facility</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="14"><xs:annotation><xs:documentation xml:lang="en">Hotel or motel paid for without emergency shelter voucher</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="7"><xs:annotation><xs:documentation xml:lang="en">Jail, prison or juvenile detention facility</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="25"><xs:annotation><xs:documentation xml:lang="en">Long-term care facility or nursing home</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="26"><xs:annotation><xs:documentation xml:lang="en">Moved from one HOPWA funded project to HOPWA PH</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="27"><xs:annotation><xs:documentation xml:lang="en">Moved from one HOPWA funded project to HOPWA TH</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="11"><xs:annotation><xs:documentation xml:lang="en">Owned by client, no ongoing housing subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="21"><xs:annotation><xs:documentation xml:lang="en">Owned by client, with ongoing housing subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Permanent housing for formerly homeless persons (such as: CoC project; or HUD legacy programs; or HOPWA PH)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="16"><xs:annotation><xs:documentation xml:lang="en">Place not meant for habitation (e.g., a vehicle, an abandoned building, bus/train/subway station/airport or anywhere outside)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Psychiatric hospital or other psychiatric facility</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="10"><xs:annotation><xs:documentation xml:lang="en">Rental by client, no ongoing housing subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="19"><xs:annotation><xs:documentation xml:lang="en">Rental by client, with VASH housing subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="28"><xs:annotation><xs:documentation xml:lang="en">Rental by client, with GPD TIP housing subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="20"><xs:annotation><xs:documentation xml:lang="en">Rental by client, with other ongoing housing subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="29"><xs:annotation><xs:documentation xml:lang="en">Residential project or halfway house with no homeless criteria</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="18"><xs:annotation><xs:documentation xml:lang="en">Safe Haven</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="22"><xs:annotation><xs:documentation xml:lang="en">Staying or living with family, permanent tenure</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="12"><xs:annotation><xs:documentation xml:lang="en">Staying or living with family, temporary tenure (e.g., room, apartment or house)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="23"><xs:annotation><xs:documentation xml:lang="en">Staying or living with friends, permanent tenure</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="13"><xs:annotation><xs:documentation xml:lang="en">Staying or living with friends, temporary tenure (e.g., room apartment or house)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="5"><xs:annotation><xs:documentation xml:lang="en">Substance abuse treatment facility or detox center</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Transitional housing for homeless persons (including homeless youth)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="17"><xs:annotation><xs:documentation xml:lang="en">x</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="30"><xs:annotation><xs:documentation xml:lang="en">No exit interview completed</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="8"><xs:annotation><xs:documentation xml:lang="en">Client doesn’t know</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="9"><xs:annotation><xs:documentation xml:lang="en">Client refused</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:complexType name="exitHousingAssessment"><xs:sequence><xs:element name="ExitHousingAssessmentID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the ExitHousingAssessment's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ExitID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="HousingAssessment" type="hmis:housingAssessmentAtExit"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.19.1.</xs:documentation></xs:annotation></xs:element><xs:element name="SubsidyInformation" type="hmis:subsidyInformation" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.19.1A.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/></xs:complexType>
Housing Assessment at Exit1 = Able to maintain the housing they had at project entry2 = Moved to new housing unit3 = Moved in with family/friends on a temporary basis4 = Moved in with family/friends on a permanent basis5 = Moved to a transitional or temporary housing facility or program6 = Client became homeless – moving to a shelter or other place unfit for human habitation7 = Client went to jail/prison10 = Client died8 = Client doesn’t know9 = Client refused99 = Data not collected
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
1
Able to maintain the housing they had at project entry
enumeration
2
Moved to new housing unit
enumeration
3
Moved in with family/friends on a temporary basis
enumeration
4
Moved in with family/friends on a permanent basis
enumeration
5
Moved to a transitional or temporary housing facility or program
enumeration
6
Client became homeless – moving to a shelter or other place unfit for human habitation
<xs:simpleType name="housingAssessmentAtExit"><xs:annotation><xs:documentation xml:lang="en">Housing Assessment at Exit 1 = Able to maintain the housing they had at project entry 2 = Moved to new housing unit 3 = Moved in with family/friends on a temporary basis 4 = Moved in with family/friends on a permanent basis 5 = Moved to a transitional or temporary housing facility or program 6 = Client became homeless – moving to a shelter or other place unfit for human habitation 7 = Client went to jail/prison 10 = Client died 8 = Client doesn’t know 9 = Client refused 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Able to maintain the housing they had at project entry</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Moved to new housing unit</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Moved in with family/friends on a temporary basis</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Moved in with family/friends on a permanent basis</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="5"><xs:annotation><xs:documentation xml:lang="en">Moved to a transitional or temporary housing facility or program</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="6"><xs:annotation><xs:documentation xml:lang="en">Client became homeless – moving to a shelter or other place unfit for human habitation</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="7"><xs:annotation><xs:documentation xml:lang="en">Client went to jail/prison</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="10"><xs:annotation><xs:documentation xml:lang="en">Client died</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="8"><xs:annotation><xs:documentation xml:lang="en">Client doesn’t know</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="9"><xs:annotation><xs:documentation xml:lang="en">Client refused</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
Subsidy information1 = Without a subsidy2 = With the subsidy they had at project entry3 = With an on-going subsidy acquired since project entry4 = Only with financial assistance other than a subsidy11 = With on-going subsidy12 = Without an on-going subsidy
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
1
Without a subsidy
enumeration
2
With the subsidy they had at project entry
enumeration
3
With an on-going subsidy acquired since project entry
enumeration
4
Only with financial assistance other than a subsidy
<xs:simpleType name="subsidyInformation"><xs:annotation><xs:documentation xml:lang="en">Subsidy information 1 = Without a subsidy 2 = With the subsidy they had at project entry 3 = With an on-going subsidy acquired since project entry 4 = Only with financial assistance other than a subsidy 11 = With on-going subsidy 12 = Without an on-going subsidy</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Without a subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">With the subsidy they had at project entry</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">With an on-going subsidy acquired since project entry</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Only with financial assistance other than a subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="11"><xs:annotation><xs:documentation xml:lang="en">With on-going subsidy</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="12"><xs:annotation><xs:documentation xml:lang="en">Without an on-going subsidy</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:complexType name="exitRHY"><xs:sequence><xs:element name="ExitRHYID" type="hmis:string32" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Reference to the ExitRHY' unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ExitID" type="hmis:string32" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="WrittenAftercarePlan" type="hmis:noYesRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.36.1.</xs:documentation></xs:annotation></xs:element><xs:element name="AssistanceMainstreamBenefits" type="hmis:noYesRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.36.2.</xs:documentation></xs:annotation></xs:element><xs:element name="PermanentHousingPlacement" type="hmis:noYesRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.36.3.</xs:documentation></xs:annotation></xs:element><xs:element name="TemporaryShelterPlacement" type="hmis:noYesRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.36.4.</xs:documentation></xs:annotation></xs:element><xs:element name="ExitCounseling" type="hmis:noYesRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.36.5.</xs:documentation></xs:annotation></xs:element><xs:element name="FurtherFollowUpServices" type="hmis:noYesRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.36.6.</xs:documentation></xs:annotation></xs:element><xs:element name="ScheduledFollowUpContacts" type="hmis:noYesRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.36.7.</xs:documentation></xs:annotation></xs:element><xs:element name="ResourcePackage" type="hmis:noYesRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.36.8.</xs:documentation></xs:annotation></xs:element><xs:element name="OtherAftercarePlanOrAction" type="hmis:noYesRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.36.9.</xs:documentation></xs:annotation></xs:element><xs:element name="FamilyReunificationAchieved" type="hmis:fiveValDKRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.38.1.</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectCompletionStatus" type="hmis:projectCompletionStatusSimple" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.37.1. In communities exporting HUDVASH VA Repository, may also contain data for HUD-VASH Exit Information (not defined in the HMIS Data Standards) using list 4.51.1</xs:documentation></xs:annotation></xs:element><xs:element name="EarlyExitReason" type="hmis:earlyExitReason" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.37, 1A or 1B, depending on whether 2 (use 1A) or 3 (use 1B) is the response to 4.37.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/></xs:complexType>
Project Completion Status1 = Completed project2 = Youth voluntarily left early3 = Youth was expelled or otherwise involuntarily discharged from project99 = Data not collected*In communities exporting HUDVASH OTH data for upload to the VA Repository, may also contain data for HUD-VASH Exit Information (not defined in theHMIS Data Standards) using list 4.51.1 below:4.51.1 HUD VASH Exit Information1 = Accomplished goals and/or obtained services and no longer needs CM2 = Transferred to another HUD/VASH program site3 = Found/chose other housing4 = Did not comply with HUD/VASH CM5 = Eviction and/or other housing related issues6 = Unhappy with HUD/VASH housing7 = No longer financially eligible for HUD/VASH voucher8 = No longer interested in participating in this program9 = Veteran cannot be located10 = Veteran too ill to participate at this time11 = Veteran is incarcerated12 = Veteran is deceased13 = Other
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
1
Completed project
enumeration
2
Youth voluntarily left early
enumeration
3
Youth was expelled or otherwise involuntarily discharged from project
<xs:simpleType name="projectCompletionStatusSimple"><xs:annotation><xs:documentation xml:lang="en">Project Completion Status 1 = Completed project 2 = Youth voluntarily left early 3 = Youth was expelled or otherwise involuntarily discharged from project 99 = Data not collected *In communities exporting HUDVASH OTH data for upload to the VA Repository, may also contain data for HUD-VASH Exit Information (not defined in the HMIS Data Standards) using list 4.51.1 below: 4.51.1 HUD VASH Exit Information 1 = Accomplished goals and/or obtained services and no longer needs CM 2 = Transferred to another HUD/VASH program site 3 = Found/chose other housing 4 = Did not comply with HUD/VASH CM 5 = Eviction and/or other housing related issues 6 = Unhappy with HUD/VASH housing 7 = No longer financially eligible for HUD/VASH voucher 8 = No longer interested in participating in this program 9 = Veteran cannot be located 10 = Veteran too ill to participate at this time 11 = Veteran is incarcerated 12 = Veteran is deceased 13 = Other</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Completed project</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Youth voluntarily left early</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Youth was expelled or otherwise involuntarily discharged from project</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
Select the major reason (1-6 depend on answer to 4.37 Project Completion Status) 1 = if 4.37A: Left for other opportunities – Independent living *OR* if 4.37B: Criminal activity/destruction of property/violence2 = if 4.37A: Left for other opportunities - Education *OR* if 4.37B: Non-compliance with project rules3 = if 4.37A: Left for other opportunities - Military *OR* if 4.37B: Non-payment of rent/occupancy charge4 = if 4.37A: Left for other opportunities - Other *OR* if 4.37B: Reached maximum time allowed by project5 = if 4.37A: Needs could not be met by project *OR* if 4.37B: Project terminated6 = 4.37B only: Unknown/disappeared99 = both 4.37A and 4.37B: Data not collected
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
1
Left for other opportunities – Independent living *OR* Criminal activity/destruction of property/violence
enumeration
2
Left for other opportunities - Education *OR* Non-compliance with project rules
enumeration
3
Left for other opportunities - Military *OR* Non-payment of rent/occupancy charge
enumeration
4
Left for other opportunities - Other *OR* Reached maximum time allowed by project
enumeration
5
Needs could not be met by project *OR* Project terminated
<xs:simpleType name="earlyExitReason"><xs:annotation><xs:documentation xml:lang="en">Select the major reason (1-6 depend on answer to 4.37 Project Completion Status) 1 = if 4.37A: Left for other opportunities – Independent living *OR* if 4.37B: Criminal activity/destruction of property/violence 2 = if 4.37A: Left for other opportunities - Education *OR* if 4.37B: Non-compliance with project rules 3 = if 4.37A: Left for other opportunities - Military *OR* if 4.37B: Non-payment of rent/occupancy charge 4 = if 4.37A: Left for other opportunities - Other *OR* if 4.37B: Reached maximum time allowed by project 5 = if 4.37A: Needs could not be met by project *OR* if 4.37B: Project terminated 6 = 4.37B only: Unknown/disappeared 99 = both 4.37A and 4.37B: Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Left for other opportunities – Independent living *OR* Criminal activity/destruction of property/violence</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Left for other opportunities - Education *OR* Non-compliance with project rules</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Left for other opportunities - Military *OR* Non-payment of rent/occupancy charge</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Left for other opportunities - Other *OR* Reached maximum time allowed by project</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="5"><xs:annotation><xs:documentation xml:lang="en">Needs could not be met by project *OR* Project terminated</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="6"><xs:annotation><xs:documentation xml:lang="en">Unknown/disappeared</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:complexType name="funder"><xs:sequence><xs:element name="FunderID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Funder's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to a Project element</xs:documentation></xs:annotation></xs:element><xs:element name="Funder" type="hmis:federalPartnerProgramsAndComponents"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.6.1.</xs:documentation></xs:annotation></xs:element><xs:element name="GrantID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.6.2.</xs:documentation></xs:annotation></xs:element><xs:element name="StartDate" type="xs:date"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.6.3.</xs:documentation></xs:annotation></xs:element><xs:element name="EndDate" type="xs:date" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.6.4.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/></xs:complexType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:IndianHealthServices/text()='0') then boolean(hmis:NoIndianHealthServicesReason)
else (if (not(hmis:IndianHealthServices/text()='0')) then (not(boolean(hmis:NoIndianHealthServicesReason)))
else false())
if (hmis:OtherInsurance/text()='1') then boolean(hmis:OtherInsuranceIdentify) else
(if (not(hmis:OtherInsurance/text()='1')) then (not(boolean(hmis:OtherInsuranceIdentify)))
else false())
if (hmis:Medicaid/text()='0') then boolean(hmis:NoMedicaidReason) else (if (not(hmis:Medicaid/text()='0'))
then (not(boolean(hmis:NoMedicaidReason))) else false())
if (hmis:Medicare/text()='0') then boolean(hmis:NoMedicareReason) else (if (not(hmis:Medicare/text()='0'))
then (not(boolean(hmis:NoMedicareReason))) else false())
if (hmis:SCHIP/text()='0') then boolean(hmis:NoSCHIPReason) else (if (not(hmis:SCHIP/text()='0'))
then (not(boolean(hmis:NoSCHIPReason))) else false())
if (hmis:VAMedicalServices/text()='0') then boolean(hmis:NoVAMedReason) else (if (not(hmis:VAMedicalServices/text()='0'))
then (not(boolean(hmis:NoVAMedReason))) else false())
if (hmis:EmployerProvided/text()='0') then boolean(hmis:NoEmployerProvidedReason)
else (if (not(hmis:EmployerProvided/text()='0')) then (not(boolean(hmis:NoEmployerProvidedReason)))
else false())
if (hmis:COBRA/text()='0') then boolean(hmis:NoCOBRAReason) else (if (not(hmis:COBRA/text()='0'))
then (not(boolean(hmis:NoCOBRAReason))) else false())
if (hmis:PrivatePay/text()='0') then boolean(hmis:NoPrivatePayReason) else (if (not(hmis:PrivatePay/text()='0'))
then (not(boolean(hmis:NoPrivatePayReason))) else false())
if (hmis:StateHealthIns/text()='0') then boolean(hmis:NoStateHealthInsReason) else
(if (not(hmis:StateHealthIns/text()='0')) then (not(boolean(hmis:NoStateHealthInsReason)))
else false())
Source
<xs:complexType name="healthInsurance"><xs:sequence><xs:element name="HealthInsuranceID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the HealthInsurance's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="InsuranceFromAnySource" type="hmis:fiveValDKRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.2.</xs:documentation></xs:annotation></xs:element><xs:element name="Medicaid" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.3.</xs:documentation></xs:annotation></xs:element><xs:element name="NoMedicaidReason" type="reasonNotInsuredOrAssisted" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.3A.</xs:documentation></xs:annotation></xs:element><xs:element name="Medicare" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.4.</xs:documentation></xs:annotation></xs:element><xs:element name="NoMedicareReason" type="hmis:reasonNotInsuredOrAssisted" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.4A.</xs:documentation></xs:annotation></xs:element><xs:element name="SCHIP" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.5.</xs:documentation></xs:annotation></xs:element><xs:element name="NoSCHIPReason" type="hmis:reasonNotInsuredOrAssisted" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.5A.</xs:documentation></xs:annotation></xs:element><xs:element name="VAMedicalServices" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.6.</xs:documentation></xs:annotation></xs:element><xs:element name="NoVAMedReason" type="hmis:reasonNotInsuredOrAssisted" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.6A.</xs:documentation></xs:annotation></xs:element><xs:element name="EmployerProvided" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.7.</xs:documentation></xs:annotation></xs:element><xs:element name="NoEmployerProvidedReason" type="hmis:reasonNotInsuredOrAssisted" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.7A.</xs:documentation></xs:annotation></xs:element><xs:element name="COBRA" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.8.</xs:documentation></xs:annotation></xs:element><xs:element name="NoCOBRAReason" type="hmis:reasonNotInsuredOrAssisted" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.8A.</xs:documentation></xs:annotation></xs:element><xs:element name="PrivatePay" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.9.</xs:documentation></xs:annotation></xs:element><xs:element name="NoPrivatePayReason" type="hmis:reasonNotInsuredOrAssisted" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.9A.</xs:documentation></xs:annotation></xs:element><xs:element name="StateHealthIns" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.10.</xs:documentation></xs:annotation></xs:element><xs:element name="NoStateHealthInsReason" type="hmis:reasonNotInsuredOrAssisted" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.10A.</xs:documentation></xs:annotation></xs:element><xs:element name="IndianHealthServices" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.11.</xs:documentation></xs:annotation></xs:element><xs:element name="NoIndianHealthServicesReason" type="hmis:reasonNotInsuredOrAssisted" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.11A.</xs:documentation></xs:annotation></xs:element><xs:element name="OtherInsurance" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.12.</xs:documentation></xs:annotation></xs:element><xs:element name="OtherInsuranceIdentify" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.4.12A.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attribute ref="hmis:dataCollectionStage" use="required"/><xs:attribute ref="hmis:informationDate" use="required"/><xs:attributeGroup ref="hmis:baseMetaData"/><!--Testing if IndianHealthServices is 0, before allowing use of NoIndianHealthServicesReason--><xs:assert test="if (hmis:IndianHealthServices/text()='0') then boolean(hmis:NoIndianHealthServicesReason) else (if (not(hmis:IndianHealthServices/text()='0')) then (not(boolean(hmis:NoIndianHealthServicesReason))) else false())"/><!--Testing if OtherInsurance is 1, before allowing use of OtherInsuranceIdentify--><xs:assert test="if (hmis:OtherInsurance/text()='1') then boolean(hmis:OtherInsuranceIdentify) else (if (not(hmis:OtherInsurance/text()='1')) then (not(boolean(hmis:OtherInsuranceIdentify))) else false())"/><!--Testing if Medicaid is 0, before allowing use of NoMedicaidReason--><xs:assert test="if (hmis:Medicaid/text()='0') then boolean(hmis:NoMedicaidReason) else (if (not(hmis:Medicaid/text()='0')) then (not(boolean(hmis:NoMedicaidReason))) else false())"/><!--Testing if Medicare is 0, before allowing use of NoMedicareReason--><xs:assert test="if (hmis:Medicare/text()='0') then boolean(hmis:NoMedicareReason) else (if (not(hmis:Medicare/text()='0')) then (not(boolean(hmis:NoMedicareReason))) else false())"/><!--Testing if SCHIP is 0, before allowing use of NoSCHIPReason--><xs:assert test="if (hmis:SCHIP/text()='0') then boolean(hmis:NoSCHIPReason) else (if (not(hmis:SCHIP/text()='0')) then (not(boolean(hmis:NoSCHIPReason))) else false())"/><!--Testing if VAMedicalServices is 0, before allowing use of NoVAMedReason--><xs:assert test="if (hmis:VAMedicalServices/text()='0') then boolean(hmis:NoVAMedReason) else (if (not(hmis:VAMedicalServices/text()='0')) then (not(boolean(hmis:NoVAMedReason))) else false())"/><!--Testing if EmployerProvided is 0, before allowing use of NoVAMedReason--><xs:assert test="if (hmis:EmployerProvided/text()='0') then boolean(hmis:NoEmployerProvidedReason) else (if (not(hmis:EmployerProvided/text()='0')) then (not(boolean(hmis:NoEmployerProvidedReason))) else false())"/><!--Testing if COBRA is 0, before allowing use of NoCOBRAReason--><xs:assert test="if (hmis:COBRA/text()='0') then boolean(hmis:NoCOBRAReason) else (if (not(hmis:COBRA/text()='0')) then (not(boolean(hmis:NoCOBRAReason))) else false())"/><!--Testing if PrivatePay is 0, before allowing use of NoPrivatePayReason--><xs:assert test="if (hmis:PrivatePay/text()='0') then boolean(hmis:NoPrivatePayReason) else (if (not(hmis:PrivatePay/text()='0')) then (not(boolean(hmis:NoPrivatePayReason))) else false())"/><!--Testing if StateHealthIns is 0, before allowing use of NoStateHealthInsReason--><xs:assert test="if (hmis:StateHealthIns/text()='0') then boolean(hmis:NoStateHealthInsReason) else (if (not(hmis:StateHealthIns/text()='0')) then (not(boolean(hmis:NoStateHealthInsReason))) else false())"/></xs:complexType>
1 = Applied; decision pending2 = Applied; client not eligible3 = Client did not apply4 = Insurance type not applicable for this client8 = Client doesn’t know9 = Client refused99 = Data not collected
<xs:simpleType name="reasonNotInsuredOrAssisted"><xs:annotation><xs:documentation xml:lang="en">1 = Applied; decision pending 2 = Applied; client not eligible 3 = Client did not apply 4 = Insurance type not applicable for this client 8 = Client doesn’t know 9 = Client refused 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Applied; decision pending</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Applied; client not eligible</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Client did not apply</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Insurance type not applicable for this client</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="8"><xs:annotation><xs:documentation xml:lang="en">Client doesn’t know</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="9"><xs:annotation><xs:documentation xml:lang="en">Client refused</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:complexType name="healthStatus"><xs:sequence><xs:element name="HealthStatusID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the HealthStatus' unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="HealthCategory" type="hmis:healthCategory"><xs:annotation><xs:documentation xml:lang="en">The permissible values correspond to the decimal values of the corresponding health category. 4.27 General Health Status is "27" and 4.29 Mental Health Status is "29" and 4.30 Pregnancy Status is "30".</xs:documentation></xs:annotation></xs:element><xs:element name="HealthStatus" type="hmis:healthStatusType"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.27-4.30.1.</xs:documentation></xs:annotation></xs:element><xs:element name="DueDate" type="xs:date" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.30.1A.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attribute ref="hmis:dataCollectionStage" use="required"/><xs:attribute ref="hmis:informationDate" use="required"/><xs:attributeGroup ref="hmis:baseMetaData"/></xs:complexType>
<xs:simpleType name="healthCategory"><xs:annotation><xs:documentation xml:lang="en">Health Category 27 = General Health Status 28 = Dental Health Status 29 = Mental Health Status 30 = Pregnancy Status</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="27"><xs:annotation><xs:documentation xml:lang="en">General Health Status</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="28"><xs:annotation><xs:documentation xml:lang="en">Dental Health Status</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="29"><xs:annotation><xs:documentation xml:lang="en">Mental Health Status</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:complexType name="housingAssessmentDisposition"><xs:sequence><xs:element name="HousingAssessmentDispositionID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the HousingAssessmentDisposition's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ExitID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the ExitID</xs:documentation></xs:annotation></xs:element><xs:element name="AssessmentDisposition" type="hmis:assessmentDisposition"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.18.1.</xs:documentation></xs:annotation></xs:element><xs:element name="OtherDisposition" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.18.1A.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/></xs:complexType>
Assessment Disposition1 = Referred to emergency shelter/safe haven2 = Referred to transitional housing3 = Referred to rapid re-housing4 = Referred to permanent supportive housing5 = Referred to homelessness prevention6 = Referred to street outreach7 = Referred to other continuum project type8 = Referred to a homelessness diversion program9 = Unable to refer/accept within continuum; ineligible for continuum projects10 = Unable to refer/accept within continuum; continuum services unavailable11 = Referred to other community project (non-continuum)12 = Applicant declined referral/acceptance13 = Applicant terminated assessment prior to completion14 = Other/specify
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
1
Referred to emergency shelter/safe haven
enumeration
2
Referred to transitional housing
enumeration
3
Referred to rapid re-housing
enumeration
4
Referred to permanent supportive housing
enumeration
5
Referred to homelessness prevention
enumeration
6
Referred to street outreach
enumeration
7
Referred to other continuum project type
enumeration
8
Referred to a homelessness diversion program
enumeration
9
Unable to refer/accept within continuum; ineligible for continuum projects
enumeration
10
Unable to refer/accept within continuum; continuum services unavailable
enumeration
11
Referred to other community project (non-continuum)
enumeration
12
Applicant declined referral/acceptance
enumeration
13
Applicant terminated assessment prior to completion
<xs:simpleType name="assessmentDisposition"><xs:annotation><xs:documentation xml:lang="en">Assessment Disposition 1 = Referred to emergency shelter/safe haven 2 = Referred to transitional housing 3 = Referred to rapid re-housing 4 = Referred to permanent supportive housing 5 = Referred to homelessness prevention 6 = Referred to street outreach 7 = Referred to other continuum project type 8 = Referred to a homelessness diversion program 9 = Unable to refer/accept within continuum; ineligible for continuum projects 10 = Unable to refer/accept within continuum; continuum services unavailable 11 = Referred to other community project (non-continuum) 12 = Applicant declined referral/acceptance 13 = Applicant terminated assessment prior to completion 14 = Other/specify</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Referred to emergency shelter/safe haven</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Referred to transitional housing</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Referred to rapid re-housing</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Referred to permanent supportive housing</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="5"><xs:annotation><xs:documentation xml:lang="en">Referred to homelessness prevention</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="6"><xs:annotation><xs:documentation xml:lang="en">Referred to street outreach</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="7"><xs:annotation><xs:documentation xml:lang="en">Referred to other continuum project type</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="8"><xs:annotation><xs:documentation xml:lang="en">Referred to a homelessness diversion program</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="9"><xs:annotation><xs:documentation xml:lang="en">Unable to refer/accept within continuum; ineligible for continuum projects</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="10"><xs:annotation><xs:documentation xml:lang="en">Unable to refer/accept within continuum; continuum services unavailable</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="11"><xs:annotation><xs:documentation xml:lang="en">Referred to other community project (non-continuum)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="12"><xs:annotation><xs:documentation xml:lang="en">Applicant declined referral/acceptance</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="13"><xs:annotation><xs:documentation xml:lang="en">Applicant terminated assessment prior to completion</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="14"><xs:annotation><xs:documentation xml:lang="en">Other/specify</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:Earned/text()='1') then boolean(hmis:EarnedAmount) else (if (not(Earned/text()='1'))
then (not(boolean(hmis:EarnedAmount))) else false())
if (hmis:Unemployment/text()='1') then boolean(hmis:UnemploymentAmount) else (if (not(Unemployment/text()='1'))
then (not(boolean(hmis:UnemploymentAmount))) else false())
if (hmis:SSI/text()='1') then boolean(hmis:SSIAmount) else (if (not(SSI/text()='1'))
then (not(boolean(hmis:SSIAmount))) else false())
if (hmis:SSDI/text()='1') then boolean(hmis:SSDIAmount) else (if (not(SSDI/text()='1'))
then (not(boolean(hmis:SSDIAmount))) else false())
if (hmis:VADisabilityService/text()='1') then boolean(hmis:VADisabilityServiceAmount)
else (if (not(VADisabilityService/text()='1')) then (not(boolean(hmis:VADisabilityServiceAmount)))
else false())
if (hmis:PrivateDisability/text()='1') then boolean(hmis:PrivateDisabilityAmount)
else (if (not(PrivateDisability/text()='1')) then (not(boolean(hmis:PrivateDisabilityAmount)))
else false())
if (hmis:WorkersComp/text()='1') then boolean(hmis:WorkersCompAmount) else (if (not(WorkersComp/text()='1'))
then (not(boolean(hmis:WorkersCompAmount))) else false())
if (hmis:TANF/text()='1') then boolean(hmis:TANFAmount) else (if (not(TANF/text()='1'))
then (not(boolean(hmis:TANFAmount))) else false())
if (hmis:GA/text()='1') then boolean(hmis:GAAmount) else (if (not(GA/text()='1'))
then (not(boolean(hmis:GAAmount))) else false())
if (hmis:SocSecRetirement/text()='1') then boolean(hmis:SocSecRetirementAmount) else
(if (not(SocSecRetirement/text()='1')) then (not(boolean(hmis:SocSecRetirementAmount)))
else false())
if (hmis:Pension/text()='1') then boolean(hmis:PensionAmount) else (if (not(Pension/text()='1'))
then (not(boolean(hmis:PensionAmount))) else false())
if (hmis:ChildSupport/text()='1') then boolean(hmis:ChildSupportAmount) else (if (not(ChildSupport/text()='1'))
then (not(boolean(hmis:ChildSupportAmount))) else false())
if (hmis:Alimony/text()='1') then boolean(hmis:AlimonyAmount) else (if (not(Alimony/text()='1'))
then (not(boolean(hmis:AlimonyAmount))) else false())
if (hmis:OtherSource/text()='1') then boolean(hmis:OtherSourceAmount) else (if (not(OtherSource/text()='1'))
then (not(boolean(hmis:OtherSourceAmount))) else false())
if (hmis:OtherSource/text()='1') then boolean(hmis:OtherSourceIdentify) else (if (not(OtherSource/text()='1'))
then (not(boolean(hmis:OtherSourceIdentify))) else false())
Source
<xs:complexType name="incomeAndSources"><xs:sequence><xs:element name="IncomeAndSourcesID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the IncomeAndSources' unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="IncomeFromAnySource" type="hmis:fiveValDKRefused"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.2.</xs:documentation></xs:annotation></xs:element><xs:element name="TotalMonthlyIncome" type="hmis:money"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.18.</xs:documentation></xs:annotation></xs:element><xs:element name="Earned" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.3.</xs:documentation></xs:annotation></xs:element><xs:element name="EarnedAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.3A.</xs:documentation></xs:annotation></xs:element><xs:element name="Unemployment" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.4.</xs:documentation></xs:annotation></xs:element><xs:element name="UnemploymentAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.4B.</xs:documentation></xs:annotation></xs:element><xs:element name="SSI" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.5.</xs:documentation></xs:annotation></xs:element><xs:element name="SSIAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.5C.</xs:documentation></xs:annotation></xs:element><xs:element name="SSDI" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.6.</xs:documentation></xs:annotation></xs:element><xs:element name="SSDIAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.6D.</xs:documentation></xs:annotation></xs:element><xs:element name="VADisabilityService" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.7.</xs:documentation></xs:annotation></xs:element><xs:element name="VADisabilityServiceAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.7E.</xs:documentation></xs:annotation></xs:element><xs:element name="VADisabilityNonService" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.8.</xs:documentation></xs:annotation></xs:element><xs:element name="VADisabilityNonServiceAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.8F.</xs:documentation></xs:annotation></xs:element><xs:element name="PrivateDisability" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.9.</xs:documentation></xs:annotation></xs:element><xs:element name="PrivateDisabilityAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.9G.</xs:documentation></xs:annotation></xs:element><xs:element name="WorkersComp" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.10.</xs:documentation></xs:annotation></xs:element><xs:element name="WorkersCompAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.10H.</xs:documentation></xs:annotation></xs:element><xs:element name="TANF" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.11.</xs:documentation></xs:annotation></xs:element><xs:element name="TANFAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.11I.</xs:documentation></xs:annotation></xs:element><xs:element name="GA" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.12.</xs:documentation></xs:annotation></xs:element><xs:element name="GAAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.12J.</xs:documentation></xs:annotation></xs:element><xs:element name="SocSecRetirement" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.13.</xs:documentation></xs:annotation></xs:element><xs:element name="SocSecRetirementAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.13K.</xs:documentation></xs:annotation></xs:element><xs:element name="Pension" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.14.</xs:documentation></xs:annotation></xs:element><xs:element name="PensionAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.14L.</xs:documentation></xs:annotation></xs:element><xs:element name="ChildSupport" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.15.</xs:documentation></xs:annotation></xs:element><xs:element name="ChildSupportAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.15M.</xs:documentation></xs:annotation></xs:element><xs:element name="Alimony" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.16.</xs:documentation></xs:annotation></xs:element><xs:element name="AlimonyAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.16N.</xs:documentation></xs:annotation></xs:element><xs:element name="OtherSource" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.17.</xs:documentation></xs:annotation></xs:element><xs:element name="OtherSourceAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.17O.</xs:documentation></xs:annotation></xs:element><xs:element name="OtherSourceIdentify" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.2.17O.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attribute ref="hmis:dataCollectionStage" use="required"/><xs:attribute ref="hmis:informationDate" use="required"/><xs:attributeGroup ref="hmis:baseMetaData"/><!--Testing if Earned is 1, before allowing use of EarnedAmount--><xs:assert test="if (hmis:Earned/text()='1') then boolean(hmis:EarnedAmount) else (if (not(Earned/text()='1')) then (not(boolean(hmis:EarnedAmount))) else false())"/><!--Testing if Unemployment is 1, before allowing use of UnemploymentAmount--><xs:assert test="if (hmis:Unemployment/text()='1') then boolean(hmis:UnemploymentAmount) else (if (not(Unemployment/text()='1')) then (not(boolean(hmis:UnemploymentAmount))) else false())"/><!--Testing if SSI is 1, before allowing use of SSIAmount--><xs:assert test="if (hmis:SSI/text()='1') then boolean(hmis:SSIAmount) else (if (not(SSI/text()='1')) then (not(boolean(hmis:SSIAmount))) else false())"/><!--Testing if SSDI is 1, before allowing use of SSDIAmount--><xs:assert test="if (hmis:SSDI/text()='1') then boolean(hmis:SSDIAmount) else (if (not(SSDI/text()='1')) then (not(boolean(hmis:SSDIAmount))) else false())"/><!--Testing if VADisabilityService is 1, before allowing use of VADisabilityServiceAmount--><xs:assert test="if (hmis:VADisabilityService/text()='1') then boolean(hmis:VADisabilityServiceAmount) else (if (not(VADisabilityService/text()='1')) then (not(boolean(hmis:VADisabilityServiceAmount))) else false())"/><!--Testing if PrivateDisability is 1, before allowing use of PrivateDisabilityAmount--><xs:assert test="if (hmis:PrivateDisability/text()='1') then boolean(hmis:PrivateDisabilityAmount) else (if (not(PrivateDisability/text()='1')) then (not(boolean(hmis:PrivateDisabilityAmount))) else false())"/><!--Testing if WorkersComp is 1, before allowing use of WorkersCompAmount--><xs:assert test="if (hmis:WorkersComp/text()='1') then boolean(hmis:WorkersCompAmount) else (if (not(WorkersComp/text()='1')) then (not(boolean(hmis:WorkersCompAmount))) else false())"/><!--Testing if TANF is 1, before allowing use of TANFAmount--><xs:assert test="if (hmis:TANF/text()='1') then boolean(hmis:TANFAmount) else (if (not(TANF/text()='1')) then (not(boolean(hmis:TANFAmount))) else false())"/><!--Testing if GA is 1, before allowing use of GAAmount--><xs:assert test="if (hmis:GA/text()='1') then boolean(hmis:GAAmount) else (if (not(GA/text()='1')) then (not(boolean(hmis:GAAmount))) else false())"/><!--Testing if SocSecRetirement is 1, before allowing use of SocSecRetirementAmount--><xs:assert test="if (hmis:SocSecRetirement/text()='1') then boolean(hmis:SocSecRetirementAmount) else (if (not(SocSecRetirement/text()='1')) then (not(boolean(hmis:SocSecRetirementAmount))) else false())"/><!--Testing if Pension is 1, before allowing use of PensionAmount--><xs:assert test="if (hmis:Pension/text()='1') then boolean(hmis:PensionAmount) else (if (not(Pension/text()='1')) then (not(boolean(hmis:PensionAmount))) else false())"/><!--Testing if ChildSupport is 1, before allowing use of ChildSupportAmount--><xs:assert test="if (hmis:ChildSupport/text()='1') then boolean(hmis:ChildSupportAmount) else (if (not(ChildSupport/text()='1')) then (not(boolean(hmis:ChildSupportAmount))) else false())"/><!--Testing if Alimony is 1, before allowing use of AlimonyAmount--><xs:assert test="if (hmis:Alimony/text()='1') then boolean(hmis:AlimonyAmount) else (if (not(Alimony/text()='1')) then (not(boolean(hmis:AlimonyAmount))) else false())"/><!--Testing if OtherSource is 1, before allowing use of OtherSourceAmount--><xs:assert test="if (hmis:OtherSource/text()='1') then boolean(hmis:OtherSourceAmount) else (if (not(OtherSource/text()='1')) then (not(boolean(hmis:OtherSourceAmount))) else false())"/><!--Testing if OtherSource is 1, before allowing use of OtherSourceIdentify--><xs:assert test="if (hmis:OtherSource/text()='1') then boolean(hmis:OtherSourceIdentify) else (if (not(OtherSource/text()='1')) then (not(boolean(hmis:OtherSourceIdentify))) else false())"/></xs:complexType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:simpleType name="householdType"><xs:annotation><xs:documentation xml:lang="en">Name Data Quality 1 = Households without children 3 = Households with at least one adult and one child 4 = Households with only children</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Households without children</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Households with at least one adult and one child</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Households with only children</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
<xs:simpleType name="youthAgeGroup"><xs:annotation><xs:documentation xml:lang="en">Of the youth beds what number are restricted to: 1 = Only under age 18 2 = Only ages 18 to 24 3 = Only youth under age 24 (both of the above)</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Only under age 18</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Only ages 18 to 24</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Only youth under age 24 (both of the above)</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:HIVAIDSAssistance/text()='0') then boolean(hmis:NoHIVAIDSAssistanceReason)
else (if (not(hmis:HIVAIDSAssistance/text()='0')) then (not(boolean(hmis:NoHIVAIDSAssistanceReason)))
else false())
Source
<xs:complexType name="medicalAssistance"><xs:sequence><xs:element name="MedicalAssistanceID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the MedicalAssistance's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="HIVAIDSAssistance" type="hmis:fiveValDKRefused"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.39.2.</xs:documentation></xs:annotation></xs:element><xs:element name="NoHIVAIDSAssistanceReason" type="hmis:reasonNotInsuredOrAssisted" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.39.2A.</xs:documentation></xs:annotation></xs:element><xs:element name="ADAP" type="hmis:fiveValDKRefused"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.39.3.</xs:documentation></xs:annotation></xs:element><xs:element name="NoADAPReason" type="hmis:reasonNotInsuredOrAssisted" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.39.3B.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attribute ref="hmis:dataCollectionStage" use="required"/><xs:attribute ref="hmis:informationDate" use="required"/><xs:attributeGroup ref="hmis:baseMetaData"/><!--Testing if HIVAIDSAssistance is 0, before allowing use of NoHIVAIDSAssistanceReason--><xs:assert test="if (hmis:HIVAIDSAssistance/text()='0') then boolean(hmis:NoHIVAIDSAssistanceReason) else (if (not(hmis:HIVAIDSAssistance/text()='0')) then (not(boolean(hmis:NoHIVAIDSAssistanceReason))) else false())"/></xs:complexType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:complexType name="organization"><xs:sequence><xs:element name="OrganizationID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.1.1.</xs:documentation></xs:annotation></xs:element><xs:element name="OrganizationName" type="hmis:string50"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.1.2.</xs:documentation></xs:annotation></xs:element><xs:element name="OrganizationCommonName" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">Referenced but not defined in the HMIS Data Dictionary.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/></xs:complexType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:ClientEnrolledInPATH/text()='0') then boolean(hmis:ReasonNotEnrolled) else
(if (not(hmis:ClientEnrolledInPATH/text()='0')) then (not(boolean(hmis:ReasonNotEnrolled)))
else false())
Source
<xs:complexType name="pathStatus"><xs:sequence><xs:element name="PathStatusID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the PathStatus' unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="DateOfStatus" type="xs:date"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.20.1.</xs:documentation></xs:annotation></xs:element><xs:element name="ClientEnrolledInPATH" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.20.2.</xs:documentation></xs:annotation></xs:element><xs:element name="ReasonNotEnrolled" type="hmis:reasonNotEnrolled" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.20.2A.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/><!--Testing if ClientEnrolledInPATH is 0, before allowing use of ReasonNotEnrolled--><xs:assert test="if (hmis:ClientEnrolledInPATH/text()='0') then boolean(hmis:ReasonNotEnrolled) else (if (not(hmis:ClientEnrolledInPATH/text()='0')) then (not(boolean(hmis:ReasonNotEnrolled))) else false())"/></xs:complexType>
<xs:simpleType name="reasonNotEnrolled"><xs:annotation><xs:documentation xml:lang="en">Reason not enrolled 1 = Client was found ineligible for PATH 2 = Client was not enrolled for other reason(s) 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Client was found ineligible for PATH</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Client was not enrolled for other reason(s)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:simpleType name="percentAMISimple"><xs:annotation><xs:documentation xml:lang="en">Household Income as a Percentage of AMI 1 = Less than 30% 2 = 30% to 50% 3 = Greater than 50% 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Less than 30%</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">30% to 50%</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Greater than 50%</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
Address Data Quality1 = Full address reported2 = Incomplete or estimated address reported8 = Client doesn't know9 = Client refused99 = Data not collected
<xs:simpleType name="timeToHousingLoss"><xs:annotation><xs:documentation xml:lang="en">0 = 0-6 days 1 = 7-13 days 2 = 14-21 days 3 = More than 21 days (0 points) 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="0"><xs:annotation><xs:documentation xml:lang="en">0-6 days</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">7-13 days</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">14-21 days</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">More than 21 days (0 points)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
<xs:simpleType name="annualPercentAMI"><xs:annotation><xs:documentation xml:lang="en">0 = 0-14% of AMI for household size 1 = 15-30% of AMI for household size 2 = More than 30% of AMI for household size (0 points) 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="0"><xs:annotation><xs:documentation xml:lang="en">0-14% of AMI for household size</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">15-30% of AMI for household size</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">More than 30% of AMI for household size (0 points)</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
0 = 4 or more times or total of at least 12 months in past three years1 = 2-3 times in past three years2 = 1 time in past three years99 = Data not collected
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
0
4 or more times or total of at least 12 months in past three years
<xs:simpleType name="literalHomelessHistory"><xs:annotation><xs:documentation xml:lang="en">0 = 4 or more times or total of at least 12 months in past three years 1 = 2-3 times in past three years 2 = 1 time in past three years 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="0"><xs:annotation><xs:documentation xml:lang="en">4 or more times or total of at least 12 months in past three years</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">2-3 times in past three years</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">1 time in past three years</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:complexType name="project"><xs:sequence><xs:element name="ProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.2.1.</xs:documentation></xs:annotation></xs:element><xs:element name="OrganizationID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Organization</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectName" type="hmis:string50"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.2.2.</xs:documentation></xs:annotation></xs:element><xs:element name="ContinuumProject" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.4.1.</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectType" type="hmis:projectType"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.4.2.</xs:documentation></xs:annotation></xs:element><xs:element name="ResidentialAffiliation" type="hmis:noYesOnly" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">HMIS Data Dictionary, Proposed Amendment, Section 2.4.2A.</xs:documentation></xs:annotation></xs:element><xs:element name="TrackingMethod" type="hmis:trackingMethod" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.5.1.</xs:documentation></xs:annotation></xs:element><xs:element name="TargetPopulation" type="hmis:targetPopulation" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 2.9.1.</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectCommonName" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">A local or commonly used name for a project. This is not referenced in the August 2016 HMIS Data Dictionary, and is optional.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/></xs:complexType>
<xs:simpleType name="targetPopulation"><xs:annotation><xs:documentation xml:lang="en">Target Population Type 1 = DV Domestic Violence victims 3 = HIV Persons with HIV/AIDS 4 = NA Not Applicable</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">DV Domestic Violence victims</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">HIV Persons with HIV/AIDS</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">NA Not Applicable</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:complexType name="coc"><xs:sequence><xs:element name="CoCCode" type="hmis:cocCode"><xs:annotation><xs:documentation xml:lang="en">Key reference to the CoCCode ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Project ID</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/></xs:complexType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:complexType name="residentialMoveInDate"><xs:sequence><xs:element name="ResidentialMoveInDateID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the ResidentialMoveInDate's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="ResidentialMoveInDate" type="xs:date" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.17.1A.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/></xs:complexType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:FYSBYouth/text()='0') then boolean(hmis:ReasonNoServices) else (if (not(hmis:FYSBYouth/text()='0'))
then (not(boolean(hmis:ReasonNoServices))) else false())
Source
<xs:complexType name="rhyBCPStatus"><xs:sequence><xs:element name="RHYBCPStatusID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the RHYBCPStatus' unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="StatusDate" type="xs:date"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.22.1.</xs:documentation></xs:annotation></xs:element><xs:element name="FYSBYouth" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.22.2.</xs:documentation></xs:annotation></xs:element><xs:element name="ReasonNoServices" type="hmis:fysbReasonNoServices" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.22.2A.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/><!--Testing if FYSBYouth is 0, before allowing use of ReasonNoServices--><xs:assert test="if (hmis:FYSBYouth/text()='0') then boolean(hmis:ReasonNoServices) else (if (not(hmis:FYSBYouth/text()='0')) then (not(boolean(hmis:ReasonNoServices))) else false())"/></xs:complexType>
Reason for not providing services1 = Out of age range2 = Ward of the State – Immediate Reunification3 = Ward of the Criminal Justice System – Immediate Reunification4 = Other99 = Data not collected
Diagram
Type
restriction of xs:unsignedInt
Facets
enumeration
1
Out of age range
enumeration
2
Ward of the State – Immediate Reunification
enumeration
3
Ward of the Criminal Justice System – Immediate Reunification
<xs:simpleType name="fysbReasonNoServices"><xs:annotation><xs:documentation xml:lang="en">Reason for not providing services 1 = Out of age range 2 = Ward of the State – Immediate Reunification 3 = Ward of the Criminal Justice System – Immediate Reunification 4 = Other 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Out of age range</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">Ward of the State – Immediate Reunification</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Ward of the Criminal Justice System – Immediate Reunification</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="4"><xs:annotation><xs:documentation xml:lang="en">Other</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (not (hmis:RecordType/text() ='144' and hmis:TypeProvided/text() ='6')) then not
(boolean(hmis:OtherTypeProvided)) else boolean(hmis:OtherTypeProvided)
if (not (hmis:RecordType/text() ='144' and (hmis:TypeProvided/text() ='3' or hmis:TypeProvided/text()
='4' or hmis:TypeProvided/text() ='5'))) then not (boolean(hmis:SubTypeProvided))
else boolean(hmis:TypeProvided)
if (not (hmis:RecordType/text() ='151') and not (hmis:RecordType/text() ='152')) then
(not (boolean(hmis:FAAmount))) else boolean(hmis:FAAmount)
Source
<xs:complexType name="serviceFAReferral"><xs:sequence><xs:element name="ServiceFAReferralID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the Services' unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="DateProvided" type="xs:date"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.12 and 4.14-4.16.1.</xs:documentation></xs:annotation></xs:element><xs:element name="RecordType" type="hmis:recordType"><xs:annotation><xs:documentation xml:lang="en">The permissible values correspond to the decimal values of the corresponding Service FA Referral and Contact types. 4.12 Contact is "12", 4.14 Services Provided is "14X", 4.15 Financial Assistance is "15X", 4.16 Referrals Provided is "16X", Bed Night is "200", and is HUD-VASH OTH voucher tracking "210".</xs:documentation></xs:annotation></xs:element><xs:element name="TypeProvided"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.12 and 4.14-4.16.2 (picklist values vary by service category and funder).</xs:documentation><xs:documentation xml:lang="en">In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 12 (Contact Location 4.12.2): 1 = Place not meant for habitation 2 = Service setting, non-residential 3 = Service setting, residential In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 141 (PATH Services 4.14.A): PATH Services 1 = Re-engagement 2 = Screening 3 = Habilitation/rehabilitation 4 = Community mental health 5 = Substance use treatment 6 = Case management 7 = Residential supportive services 8 = Housing minor renovation 9 = Housing moving assistance 10 = Housing eligibility determination 11 = Security deposits 12 = One-time rent for eviction prevention 14 = Clinical assessment In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 142 (RHY Services 4.14.B): 1 = Basic support services 2 = Community service/service learning (CSL) 3 = Counseling/therapy 4 = Dental care 5 = Education 6 = Employment and training services 7 = Criminal justice /legal services 8 = Life skills training 9 = Parenting education for parent of youth 10 = Parenting education for youth with children 11 = Peer (youth) counseling 12 = Post-natal care 13 = Pre-natal care 14 = Health/medical care 15 = Psychological or psychiatric care 16 = Recreational activities 17 = Substance abuse assessment and/or treatment 18 = Substance abuse prevention 19 = Support group 20 = Preventative – overnight interim, respite 21 = Preventative – formal placement in an alternative setting outside of BCP 22 = Preventative – entry into BCP after preventative services 23 = Street outreach – health and hygiene products distributed 24 = Street outreach – food and drink items 25 = Street outreach – services information/brochures In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 143 (HOPWA Services 4.14.C): 1 Adult day care and personal assistance 2 Case management 3 Child care 4 Criminal justice/legal services 5 Education 6 Employment and training services 7 Food/meals/nutritional services 8 Health/medical care 9 Life skills training 10 Mental health care/counseling 11 Outreach and/or engagement 12 Substance abuse services/treatment 13 Transportation 14 Other HOPWA funded service In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 144 (SSVF Services 4.14.D): 1 Outreach services 2 Case management services 3 Assistance obtaining VA benefits 4 Assistance obtaining/coordinating other public benefits 5 Direct provision of other public benefits 6 Other (non-TFA) supportive service approved by VA In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 151 (Financial Assistance - HOPWA Services 4.15.A): 1 Rental assistance [collect for PHP and STRMU] 2 Security deposits [collect for PHP] 3 Utility deposits [collect for PHP] 4 Utility payments [collect for PHP and STRMU] 7 Mortgage assistance [collect for STRMU] In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 152 (Financial Assistance – SSVF 4.15.B): 1 Rental assistance 4 Utility fee payment assistance 2 Security deposit 3 Utility deposit 5 Moving costs 8 Transportation services: tokens/vouchers 9 Transportation services: vehicle repair/maintenance 10 Child Care 11 General housing stability assistance - emergency supplies 12 General housing stability assistance - other 14 Emergency housing assistance In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 161 (Referrals Provided – PATH 4.16.A): 1 Community Mental Health 2 Substance Use Treatment 3 Primary Health/ Dental Care 4 Job Training 5 Educational Services 6 Housing Services 11 Temporary Housing 7 Permanent Housing 8 Income Assistance 9 Employment Assistance 10 Medical Insurance In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 162 (Referrals Provided - RHY 4.16.B): 1 Child Care Non-TANF 2 Supplemental Nutritional Assistance Program (Food Stamps) 3 Education – McKinney/Vento Liaison Assistance to Remain in School 4 HUD Section 8 or Other Permanent Housing Assistance 5 Individual Development Account 6 Medicaid 7 Mentoring Program Other than RHY Agency 8 National Service (Americorp, VISTA, Learn and Serve) 9 Non-Residential Substance Abuse or Mental Health Program 10 Other Public – Federal, State, or Local Program 11 Private Non-profit Charity or Foundation Support 12 SCHIP 13 SSI, SSDI, or other Disability Insurance 14 TANF or other Welfare/Non-Disability Income Maintenance (all TANF Services) 15 Unemployment Insurance 16 WIC 17 Workforce Development (WIA) In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 200 (Services Provided - Bed-night Date 4.14E): 200 BedNight In ServicesFAReferral, use one of the following values for TypeProvided when its RecordType = 210 (Services Provided - HUD-VASH OTH voucher tracking 4.50.1): 4.50.1 VoucherTracking Value Text 1 Referral package forwarded to PHA 2 Voucher denied by PHA 3 Voucher issued by PHA 4 Voucher revoked or expired 5 Voucher in use – veteran moved into housing 6 Voucher was ported locally 7 Voucher was administratively absorbed by new PHA 8 Voucher was converted to Housing Choice Voucher 9 Veteran exited – voucher was returned 10 Veteran exited – family maintained the voucher 11 Veteran exited – prior to ever receiving a voucher 12 Other</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:integer"><xs:pattern value="[0-9]{1,3}"/></xs:restriction></xs:simpleType></xs:element><xs:element name="OtherTypeProvided" type="hmis:string50" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.12 and 4.14-4.16.2D (if it exists) .</xs:documentation></xs:annotation></xs:element><xs:element name="SubTypeProvided" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.12 and 4.14-4.16.3A, 4B, 5C (if it exists).</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:integer"><xs:pattern value="[0-9]{1,2}"/></xs:restriction></xs:simpleType></xs:element><xs:element name="FAAmount" type="hmis:money" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.15A #3 and 4.15B #2, Financial Assistance Amount.</xs:documentation></xs:annotation></xs:element><xs:element name="ReferralOutcome" type="hmis:referralOutcome" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.16A #2A.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/><!--Testing if the RecordType is '144' and the TypeProvided is '6' before requiring and even allowing the use of OtherTypeProvided --><xs:assert test="if (not (hmis:RecordType/text() ='144' and hmis:TypeProvided/text() ='6')) then not (boolean(hmis:OtherTypeProvided)) else boolean(hmis:OtherTypeProvided)"/><!--Testing if the RecordType is '144' and the TypeProvided is '3', '4', or '5' before requiring and even allowing the use of SubTypeProvided --><xs:assert test="if (not (hmis:RecordType/text() ='144' and (hmis:TypeProvided/text() ='3' or hmis:TypeProvided/text() ='4' or hmis:TypeProvided/text() ='5'))) then not (boolean(hmis:SubTypeProvided)) else boolean(hmis:TypeProvided)"/><!--Testing if the RecordType is '151' or '152' before requiring and even allowing the use of FAAmount --><xs:assert test="if (not (hmis:RecordType/text() ='151') and not (hmis:RecordType/text() ='152')) then (not (boolean(hmis:FAAmount))) else boolean(hmis:FAAmount)"/></xs:complexType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
Discharge Status 1 = Honorable 2 = General under honorable conditions 4 = Bad conduct 5 = Dishonorable 6 = Under other than honorable conditions (OTH) 7 = Uncharacterized 8 = Client doesn’t know 9 = Client refused 99 = Data not collected
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:complexType name="entryRHSP"><xs:sequence><xs:element name="EntryRHSPID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the EntryRHSP's unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="WorstHousingSituation" type="hmis:fiveValDKRefused"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.40.1.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/></xs:complexType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Asserts
Test
XPath default namespace
Annotation
if (hmis:WorkPlaceViolenceThreats/text()='1' or hmis:WorkplacePromiseDifference/text()='1')
then boolean(hmis:CoercedToContinueWork) else (if (not(hmis:WorkPlaceViolenceThreats/text()='1'
or hmis:WorkplacePromiseDifference/text()='1')) then (not(boolean(hmis:CoercedToContinueWork)))
else false())
if (hmis:WorkPlaceViolenceThreats/text()='1' or hmis:WorkplacePromiseDifference/text()='1')
then boolean(hmis:LaborExploitPastThreeMonths) else (if (not(hmis:WorkPlaceViolenceThreats/text()='1'
or hmis:WorkplacePromiseDifference/text()='1')) then (not(boolean(hmis:LaborExploitPastThreeMonths)))
else false())
if (hmis:ExchangeForSex/text()='1') then boolean(hmis:ExchangeForSexPastThreeMonths)
else (if (not(hmis:ExchangeForSex/text()='1')) then (not(boolean(hmis:ExchangeForSexPastThreeMonths)))
else false())
if (hmis:ExchangeForSex/text()='1') then boolean(hmis:CountOfExchangeForSex) else
(if (not(hmis:ExchangeForSex/text()='1')) then (not(boolean(hmis:CountOfExchangeForSex)))
else false())
if (hmis:ExchangeForSex/text()='1') then boolean(hmis:AskedOrForcedToExchangeForSex)
else (if (not(hmis:ExchangeForSex/text()='1')) then (not(boolean(hmis:AskedOrForcedToExchangeForSex)))
else false())
if (hmis:AskedOrForcedToExchangeForSex/text()='1') then boolean(hmis:AskedOrForcedToExchangeForSexPastThreeMonths)
else (if (not(hmis:AskedOrForcedToExchangeForSex/text()='1')) then (not(boolean(hmis:AskedOrForcedToExchangeForSexPastThreeMonths)))
else false())
Source
<xs:complexType name="entryRHY"><xs:sequence><xs:element name="EntryRHYID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Reference to the EntryRHY' unique ID</xs:documentation></xs:annotation></xs:element><xs:element name="ProjectEntryID" type="hmis:string32"><xs:annotation><xs:documentation xml:lang="en">Key reference to the Enrollment</xs:documentation></xs:annotation></xs:element><xs:element name="HouseholdDynamics" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.1.</xs:documentation></xs:annotation></xs:element><xs:element name="SexualOrientation" type="hmis:sexualOrientation"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.23.1.</xs:documentation></xs:annotation></xs:element><xs:element name="SexualOrientationGenderIDYouth" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.2.</xs:documentation></xs:annotation></xs:element><xs:element name="SexualOrientationGenderIDFam" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.3.</xs:documentation></xs:annotation></xs:element><xs:element name="HousingIssuesYouth" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.4.</xs:documentation></xs:annotation></xs:element><xs:element name="HousingIssuesFam" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.5.</xs:documentation></xs:annotation></xs:element><xs:element name="SchoolEducationalIssuesYouth" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.6.</xs:documentation></xs:annotation></xs:element><xs:element name="SchoolEducationalIssuesFam" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.7.</xs:documentation></xs:annotation></xs:element><xs:element name="UnemploymentYouth" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.8.</xs:documentation></xs:annotation></xs:element><xs:element name="UnemploymentFam" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.9.</xs:documentation></xs:annotation></xs:element><xs:element name="MentalHealthIssuesYouth" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.10.</xs:documentation></xs:annotation></xs:element><xs:element name="MentalHealthIssuesFam" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.11.</xs:documentation></xs:annotation></xs:element><xs:element name="HealthIssuesYouth" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.12.</xs:documentation></xs:annotation></xs:element><xs:element name="HealthIssuesFam" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.13.</xs:documentation></xs:annotation></xs:element><xs:element name="PhysicalDisabilityYouth" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.14.</xs:documentation></xs:annotation></xs:element><xs:element name="PhysicalDisabilityFam" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.15.</xs:documentation></xs:annotation></xs:element><xs:element name="MentalDisabilityYouth" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.16.</xs:documentation></xs:annotation></xs:element><xs:element name="MentalDisabilityFam" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.17.</xs:documentation></xs:annotation></xs:element><xs:element name="AbuseAndNeglectYouth" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.18.</xs:documentation></xs:annotation></xs:element><xs:element name="AbuseAndNeglectFam" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.19.</xs:documentation></xs:annotation></xs:element><xs:element name="AlcoholDrugAbuseYouth" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.20.</xs:documentation></xs:annotation></xs:element><xs:element name="AlcoholDrugAbuseFam" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.21.</xs:documentation></xs:annotation></xs:element><xs:element name="InsufficientIncome" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.22.</xs:documentation></xs:annotation></xs:element><xs:element name="ActiveMilitaryParent" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.23.</xs:documentation></xs:annotation></xs:element><xs:element name="IncarceratedParent" type="hmis:noYesOnly"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.24.</xs:documentation></xs:annotation></xs:element><xs:element name="IncarceratedParentStatus" type="hmis:incarceratedParentStatus" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.33.24A.</xs:documentation></xs:annotation></xs:element><xs:element name="WorkPlaceViolenceThreats" type="hmis:fiveValDKRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.35, B1.</xs:documentation></xs:annotation></xs:element><xs:element name="WorkplacePromiseDifference" type="hmis:fiveValDKRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.35, B2.</xs:documentation></xs:annotation></xs:element><xs:element name="CoercedToContinueWork" type="hmis:fiveValDKRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.35, BA.</xs:documentation></xs:annotation></xs:element><xs:element name="LaborExploitPastThreeMonths" type="hmis:fiveValDKRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.35, BB.</xs:documentation></xs:annotation></xs:element><xs:element name="ExchangeForSex" type="hmis:fiveValDKRefused"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.35A.1.</xs:documentation></xs:annotation></xs:element><xs:element name="ExchangeForSexPastThreeMonths" type="hmis:fiveValDKRefused"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.35A.1A</xs:documentation></xs:annotation></xs:element><xs:element name="CountOfExchangeForSex" type="hmis:countOfExchangeForSex" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.35A.1B.</xs:documentation></xs:annotation></xs:element><xs:element name="AskedOrForcedToExchangeForSex" type="hmis:askedOrForcedToExchangeForSex" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.35.1C.</xs:documentation></xs:annotation></xs:element><xs:element name="AskedOrForcedToExchangeForSexPastThreeMonths" type="hmis:fiveValDKRefused" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.35.1D.</xs:documentation></xs:annotation></xs:element><xs:element name="FormerWardJuvenileJustice" type="hmis:fiveValDKRefused"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.32.1.</xs:documentation></xs:annotation></xs:element><xs:element name="JuvenileJusticeYears" type="hmis:issuesYears" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.32.1A.</xs:documentation></xs:annotation></xs:element><xs:element name="JuvenileJusticeMonths" type="xs:unsignedInt" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.32.1AB. Values 1-11 permissible.</xs:documentation></xs:annotation></xs:element><xs:element name="FormerWardChildWelfare" type="hmis:fiveValDKRefused"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.31.1.</xs:documentation></xs:annotation></xs:element><xs:element name="ChildWelfareYears" type="hmis:issuesYears" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.31.1B.</xs:documentation></xs:annotation></xs:element><xs:element name="ChildWelfareMonths" type="xs:unsignedInt" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.31.1BA. Values 1-11 permissible.</xs:documentation></xs:annotation></xs:element><xs:element name="ReferralSource" type="hmis:referralSource"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.34.1.</xs:documentation></xs:annotation></xs:element><xs:element name="CountOutreachReferralApproaches" type="xs:unsignedInt" minOccurs="0"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 4.34.1A.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attributeGroup ref="hmis:baseMetaData"/><!--Testing if WorkPlaceViolenceThreats or WorkplacePromiseDifference is 1, before allowing use of CoercedToContinueWork--><xs:assert test="if (hmis:WorkPlaceViolenceThreats/text()='1' or hmis:WorkplacePromiseDifference/text()='1') then boolean(hmis:CoercedToContinueWork) else (if (not(hmis:WorkPlaceViolenceThreats/text()='1' or hmis:WorkplacePromiseDifference/text()='1')) then (not(boolean(hmis:CoercedToContinueWork))) else false())"/><!--Testing if WorkPlaceViolenceThreats or WorkplacePromiseDifference is 1, before allowing use of LaborExploitPastThreeMonths--><xs:assert test="if (hmis:WorkPlaceViolenceThreats/text()='1' or hmis:WorkplacePromiseDifference/text()='1') then boolean(hmis:LaborExploitPastThreeMonths) else (if (not(hmis:WorkPlaceViolenceThreats/text()='1' or hmis:WorkplacePromiseDifference/text()='1')) then (not(boolean(hmis:LaborExploitPastThreeMonths))) else false())"/><!--Testing if ExchangeForSex is 1, before allowing use of ExchangeForSexPastThreeMonths--><xs:assert test="if (hmis:ExchangeForSex/text()='1') then boolean(hmis:ExchangeForSexPastThreeMonths) else (if (not(hmis:ExchangeForSex/text()='1')) then (not(boolean(hmis:ExchangeForSexPastThreeMonths))) else false())"/><!--Testing if ExchangeForSex is 1, before allowing use of CountOfExchangeForSex--><xs:assert test="if (hmis:ExchangeForSex/text()='1') then boolean(hmis:CountOfExchangeForSex) else (if (not(hmis:ExchangeForSex/text()='1')) then (not(boolean(hmis:CountOfExchangeForSex))) else false())"/><!--Testing if ExchangeForSex is 1, before allowing use of AskedOrForcedToExchangeForSex--><xs:assert test="if (hmis:ExchangeForSex/text()='1') then boolean(hmis:AskedOrForcedToExchangeForSex) else (if (not(hmis:ExchangeForSex/text()='1')) then (not(boolean(hmis:AskedOrForcedToExchangeForSex))) else false())"/><!--Testing if AskedOrForcedToExchangeForSex is 1, before allowing use of AskedOrForcedToExchangeForSex--><xs:assert test="if (hmis:AskedOrForcedToExchangeForSex/text()='1') then boolean(hmis:AskedOrForcedToExchangeForSexPastThreeMonths) else (if (not(hmis:AskedOrForcedToExchangeForSex/text()='1')) then (not(boolean(hmis:AskedOrForcedToExchangeForSexPastThreeMonths))) else false())"/></xs:complexType>
1 = One parent / legal guardian is incarcerated2 = One parent / legal guardian is incarcerated3 = The only parent / legal guardian is incarcerated99 = Data not collected
<xs:simpleType name="incarceratedParentStatus"><xs:annotation><xs:documentation xml:lang="en">1 = One parent / legal guardian is incarcerated 2 = One parent / legal guardian is incarcerated 3 = The only parent / legal guardian is incarcerated 99 = Data not collected</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">One parent / legal guardian is incarcerated</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">One parent / legal guardian is incarcerated</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">The only parent / legal guardian is incarcerated</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="99"><xs:annotation><xs:documentation xml:lang="en">Data not collected</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
<xs:simpleType name="issuesYears"><xs:annotation><xs:documentation xml:lang="en">Number of Years 1 = Less than one year 2 = 1 to 2 years 3 = 3 to 5 or more years</xs:documentation></xs:annotation><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Less than one year</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">1 to 2 years</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">3 to 5 or more years</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType>
Hash Status 1 = Unhashed 2 = SHA-1 RHY3 = Hashed - other
Source
<xs:complexType name="ssnHashingOptionSHA1RHY"><xs:annotation><xs:documentation xml:lang="en">Concatenation of the unhashed last 4 digits of the SSN followed by SHA-1 hash of the full SSN.</xs:documentation></xs:annotation><xs:simpleContent><xs:restriction base="hmis:ssnHashingOption"><xs:length value="44"/><xs:pattern value="([a-zA-Z0-9])*"/></xs:restriction></xs:simpleContent></xs:complexType>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
<xs:attribute name="dateDeleted" type="xs:dateTime" use="optional"><xs:annotation><xs:documentation xml:lang="en">If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.</xs:documentation></xs:annotation></xs:attribute>
Hash Status 1 = Unhashed 2 = SHA-1 RHY3 = Hashed - other
Type
restriction of xs:unsignedInt
Properties
content
simple
Facets
enumeration
1
Unhashed: Data sets with this HashStatus are expected conform to data type and field length parameters defined in this document.
enumeration
2
SHA-1 RHY: The SHA-1 algorithm produces a 40-character string of letters and numbers. Data sets with a HashStatus of ‘SHA-1 RHY’ (2) will be exported consistent with the specifications of this document with the exception that the following fields in Client.csv (and no others) will be hashed using the SHA-1 standard algorithm and data types for these four fields will differ as noted: - FirstName (S40)– SHA-1 hash of the SOUNDEX of the value for first name; - MiddleName (S40) – SHA-1 hash of the SOUNDEX of the value for middle name; -LastName (S40) – SHA-1 hash of the SOUNDEX of the value for last name; and - SSN (S44) – concatenation of the unhashed last 4 digits of the SSN followed by SHA-1 hash of the full SSN.
enumeration
3
Hashed - other: The ‘Other’ HashStatus is used to identify exports in which data are hashed based on parameters mutually agreed upon by the sender and recipient of the CSV data.
<xs:attribute name="hashStatus"><xs:annotation><xs:documentation xml:lang="en">Hash Status 1 = Unhashed 2 = SHA-1 RHY 3 = Hashed - other</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:unsignedInt"><xs:enumeration value="1"><xs:annotation><xs:documentation xml:lang="en">Unhashed: Data sets with this HashStatus are expected conform to data type and field length parameters defined in this document.</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="2"><xs:annotation><xs:documentation xml:lang="en">SHA-1 RHY: The SHA-1 algorithm produces a 40-character string of letters and numbers. Data sets with a HashStatus of ‘SHA-1 RHY’ (2) will be exported consistent with the specifications of this document with the exception that the following fields in Client.csv (and no others) will be hashed using the SHA-1 standard algorithm and data types for these four fields will differ as noted: - FirstName (S40)– SHA-1 hash of the SOUNDEX of the value for first name; - MiddleName (S40) – SHA-1 hash of the SOUNDEX of the value for middle name; -LastName (S40) – SHA-1 hash of the SOUNDEX of the value for last name; and - SSN (S44) – concatenation of the unhashed last 4 digits of the SSN followed by SHA-1 hash of the full SSN.</xs:documentation></xs:annotation></xs:enumeration><xs:enumeration value="3"><xs:annotation><xs:documentation xml:lang="en">Hashed - other: The ‘Other’ HashStatus is used to identify exports in which data are hashed based on parameters mutually agreed upon by the sender and recipient of the CSV data.</xs:documentation></xs:annotation></xs:enumeration></xs:restriction></xs:simpleType></xs:attribute>
If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.
See August 2016 HMIS Data Dictionary, Section 5.7.
Source
<xs:attributeGroup name="baseMetaData"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 5.</xs:documentation></xs:annotation><xs:attribute name="dateCreated" type="xs:dateTime" use="required"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 5.1.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="dateDeleted" type="xs:dateTime" use="optional"><xs:annotation><xs:documentation xml:lang="en">If the intended record is to be deleted, this metadata allows you to both indicate the record should be deleted within the target system, as well as indicate the specific time it was deleted.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="dateUpdated" type="xs:dateTime" use="required"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 5.2.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="userID" type="hmis:string32" use="required"><xs:annotation><xs:documentation xml:lang="en">See August 2016 HMIS Data Dictionary, Section 5.7.</xs:documentation></xs:annotation></xs:attribute></xs:attributeGroup>
